mirror
/
fireblade-ecs
mirror of https://github.com/fireblade-engine/ecs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update CONTRIBUTING.md

This commit is contained in:
Christian Treffs 2020-08-28 09:39:43 +02:00 committed by GitHub
parent a8d4bee5a6
commit 075a701417
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -33,11 +33,19 @@ When contributing to this project, please feel free to discuss the change you wi
1. Open a [new pull request (PR)][ref-pull-request-new] with the patch. 1. Open a [new pull request (PR)][ref-pull-request-new] with the patch.
2. Ensure the PR description clearly describes the problem and solution. 2. Ensure the PR description clearly describes the problem and solution.
3. Link the relevant **issue** if applicable ([how to link issues in PRs][ref-pull-request-how-to]). 3. Link the relevant **issue** if applicable ([how to link issues in PRs][ref-pull-request-how-to]).
4. Ensure that [**no tests are failing**][ref-gh-actions] and **coding conventions** are held 4. Ensure that [**no tests are failing**][ref-gh-actions] and **coding conventions** are met
5. Submit the patch and await review. 5. Submit the patch and await review.
### 🆕 You want to suggest a new feature? ### 🆕 You want to suggest a new feature?
#### ☑️ Your responsibilities
- [x] Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
- [x] Ensure (cross-)platform compatibility for every change that's accepted. An addition should not reduce the number of platforms that the project supports.
- [x] Ensure **coding conventions** are met. Lint your code with the project's default tools.
- [x] Add tests for your feature that proove it's working as expected. Code coverage should not drop below it's previous value.
- [x] Ensure none of the existing tests are failing after adding your changes.
- [x] Document your public API code and ensure to add code comments where necessary.
### ⚙️ How to set up the environment and run tests ### ⚙️ How to set up the environment and run tests