FreakU
/
Retrospring
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Adjust wording of contribution guide

This commit is contained in:
Andreas Nedbal 2022-11-01 01:22:38 +01:00 committed by Andreas Nedbal
parent 503bbb5038
commit da70192f59
1 changed files with 6 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
.github/CONTRIBUTING.md vendored
View File

@ -6,34 +6,27 @@ development of Retrospring.
## Reporting bugs ## Reporting bugs
Before submitting an issue please check if there is already an existing issue. Before submitting an issue please check if there is already an existing issue.
If there is, please add any additional information or give it a "+1" in the If there is, please add any additional information or give it a 👍 reaction.
comments.
When submitting an issue please describe the issue clearly, including how to When submitting an issue please describe the issue clearly, including how to
reproduce the bug, which situations it appears in, what you expect to happen, reproduce the bug, which situations it appears in, what you expect to happen,
what actually happens, and what platform (browser and operating system) you are what actually happens, and what platform (browser and operating system) you are
using. We find screenshots (for front-end issues) very helpful. using. We find screenshots (for front-end issues) very helpful.
## Pull Requests ## Pull Requests
1. Fork it ( https://github.com/Retrospring/retrospring/fork ) 1. Fork it (https://github.com/Retrospring/retrospring/fork)
2. Create your feature branch (`git checkout -b feature-new`) 2. Create your feature branch (`git checkout -b feature/new`)
3. Commit your changes (`git commit -am 'Add some feature'`) 3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin feature-new`) 4. Push to the branch (`git push origin feature/new`)
5. Create a new Pull Request 5. Create a new Pull Request
We love pull requests! We are very happy to work with you to get your changes We love pull requests! We are very happy to work with you to get your changes
merged in, however please keep the following in mind. merged in, however please keep the following in mind.
* Please use the core team standard of `feature-*` branch naming. * Please use the core team standard of `feature/*` branch naming.
* Adhere to the coding conventions you see in the surrounding code. * Adhere to the coding conventions you see in the surrounding code.
* If you include a new feature also include tests, and make sure they'll pass. * If you include a new feature also include tests, and make sure they'll pass.
* Before submitting a pull-request, clean up the history by going over your * Before submitting a pull-request, clean up the history by going over your
commits and squashing together minor changes and fixes into the corresponding commits and squashing together minor changes and fixes into the corresponding
commits. You can do this using the interactive rebase command. commits. You can do this using the interactive rebase command.
## What to work on
If you want to know what you can help us with, like new features, check the
GitHub issues or the
[TODO](https://github.com/Retrospring/retrospring/blob/master/TODO).