-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Alexader
authored and
Alexader
committed
Mar 30, 2020
1 parent
b274054
commit 54312ea
Showing
6 changed files
with
394 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
name: 'Bug Report' | ||
about: 'As a User, I want to report a Bug.' | ||
labels: bug | ||
--- | ||
|
||
## Bug Report | ||
|
||
Please answer these questions before submitting your issue. Thanks! | ||
|
||
### 1. What did you do? | ||
|
||
<!-- If possible, provide a recipe for reproducing the error. --> | ||
|
||
### 2. What did you expect to see? | ||
|
||
### 3. What did you see instead? | ||
|
||
### 4. What version of BitXHub are you using? (`bitxhub version` on BitXHub) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
name: 'Development Task' | ||
about: 'As a BitXHub developer, I want to record a development task.' | ||
labels: enhancement | ||
--- | ||
|
||
## Development Task |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
name: 'Feature Request' | ||
about: 'As a user, I want to request a New Feature on the product.' | ||
labels: feature | ||
--- | ||
|
||
## Feature Request | ||
|
||
**Is your feature request related to a problem? Please describe:** | ||
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] --> | ||
|
||
**Describe the feature you'd like:** | ||
<!-- A clear and concise description of what you want to happen. --> | ||
|
||
**Describe alternatives you've considered:** | ||
<!-- A clear and concise description of any alternative solutions or features you've considered. --> | ||
|
||
**Teachability, Documentation, Adoption, Migration Strategy:** | ||
<!-- If you can, explain some scenarios how users might use this, situations it would be helpful in. Any API designs, mockups, or diagrams are also helpful. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
name: 'Ask a Question' | ||
about: 'I want to ask a question.' | ||
labels: question | ||
--- | ||
|
||
## General Question |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,141 @@ | ||
# Contributing | ||
|
||
## <a name="submit"></a> Submission Guidelines | ||
|
||
### <a name="submit-pr"></a> Submitting a Pull Request (PR) | ||
Before you submit your Pull Request (PR) consider the following guidelines: | ||
|
||
1. Search [GitHub](https://github.com/meshplus/bitxhub/pulls) for an open or closed PR | ||
that relates to your submission. You don't want to duplicate effort. | ||
1. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. | ||
Discussing the design up front helps to ensure that we're ready to accept your work. | ||
1. Fork the meshplus/bitxhub repo. | ||
1. Make your changes in a new git branch: | ||
|
||
```shell | ||
git checkout -b my-fix-branch master | ||
``` | ||
|
||
1. Create your patch, **including appropriate test cases**. | ||
1. Follow gofmt and golint specifications. | ||
1. Run the full test suite and ensure that all tests pass. | ||
1. Commit your changes using a descriptive commit message that follows our | ||
[commit message conventions](#commit). Adherence to these conventions | ||
is necessary because release notes are automatically generated from these messages. | ||
|
||
```shell | ||
git commit -a | ||
``` | ||
|
||
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. | ||
|
||
1. Push your branch to GitHub: | ||
|
||
```shell | ||
git push origin my-fix-branch | ||
``` | ||
|
||
1. In GitHub, send a pull request to `bitxhub:master`. | ||
|
||
* If we suggest changes then: | ||
* Make the required updates. | ||
* Re-run the test suites to ensure tests are still passing. | ||
* Rebase your branch and force push to your GitHub repository (this will update your Pull Request): | ||
|
||
```shell | ||
git rebase master -i | ||
git push -f | ||
``` | ||
|
||
That's it! Thank you for your contribution! | ||
#### After your pull request is merged | ||
After your pull request is merged, you can safely delete your branch and pull the changes | ||
from the main (upstream) repository: | ||
* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows: | ||
```shell | ||
git push origin --delete my-fix-branch | ||
``` | ||
* Check out the master branch: | ||
```shell | ||
git checkout master -f | ||
``` | ||
* Delete the local branch: | ||
```shell | ||
git branch -D my-fix-branch | ||
``` | ||
* Update your master with the latest upstream version: | ||
```shell | ||
git pull --ff upstream master | ||
``` | ||
## <a name="commit"> Commit Message Guidelines | ||
Commit Message in this repository should strictly follow the [AngularJS Git Commit Message Conventions](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines). We explain the conventions below. For detail explanation, it can be found in this [document](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#). | ||
### Commit Message Format | ||
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special | ||
format that includes a **type**, a **scope** and a **subject**: | ||
``` | ||
<type>(<scope>): <subject> | ||
<BLANK LINE> | ||
<body> | ||
<BLANK LINE> | ||
<footer> | ||
``` | ||
The **header** is mandatory and the **scope** of the header is optional. | ||
Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier | ||
to read on GitHub as well as in various git tools. | ||
The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any. | ||
### Revert | ||
If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted. | ||
### Type | ||
Must be one of the following: | ||
* **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | ||
* **ci**: Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs) | ||
* **docs**: Documentation only changes | ||
* **feat**: A new feature | ||
* **fix**: A bug fix | ||
* **perf**: A code change that improves performance | ||
* **refactor**: A code change that neither fixes a bug nor adds a feature | ||
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | ||
* **test**: Adding missing tests or correcting existing tests | ||
### Subject | ||
The subject contains a succinct description of the change: | ||
* use the imperative, present tense: "change" not "changed" nor "changes" | ||
* don't capitalize the first letter | ||
* no dot (.) at the end | ||
|
||
### Body | ||
|
||
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes". | ||
The body should include the motivation for the change and contrast this with previous behavior. | ||
|
||
### Footer | ||
|
||
The footer should contain any information about **Breaking Changes** and is also the place to | ||
reference GitHub issues that this commit **Closes**. | ||
|
||
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this. |
Oops, something went wrong.