docs/contributing.md: add issues guide. #142
Merged
Conversation
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
weeellz
reviewed
Jun 5, 2018
CONTRIBUTING.md
Outdated
| please add some useful content about issues in our contributing.md | ||
| ``` | ||
|
|
||
| 2. In issue description provide detailed information about it. If it is bug request, please write steps, how to reproduce it. |
There was a problem hiding this comment.
remove unnecessary commas and "how"
CONTRIBUTING.md
Outdated
| ``` | ||
|
|
||
| 2. In issue description provide detailed information about it. If it is bug request, please write steps, how to reproduce it. | ||
| If it is feature request, please describe problem it could solve. Also you could tell us your solution of that problem. |
There was a problem hiding this comment.
remove comma or emphasize "please"
"solution of" to "solution to"
CONTRIBUTING.md
Outdated
| 2. In issue description provide detailed information about it. If it is bug request, please write steps, how to reproduce it. | ||
| If it is feature request, please describe problem it could solve. Also you could tell us your solution of that problem. | ||
|
|
||
| The above said is also applied to **pull requests**. |
There was a problem hiding this comment.
maybe "These rules aslo applies to ..." sounds better?
CONTRIBUTING.md
Outdated
| ### Issues naming guidelines | ||
| Correct naming: | ||
| ``` | ||
| docs/conributing.md: add info about issues. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fixes #37