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 10:23:19 +02:00 committed by GitHub
parent 3fb2c1afdc
commit 645d871e62
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -23,7 +23,7 @@ When contributing to this project, please feel free to discuss the change you wi
### 🐞 You want to report a bug or file an issue?
1. Ensure that is was **not already reported** and is beeing worked on by checking [open issues][ref-issues].
1. Ensure that it was **not already reported** and is being worked on by checking [open issues][ref-issues].
2. Create a [new issue][ref-issues-new] with a **clear and descriptive title**
3. Write a **detailed comment** with as much relevant information as possible including
- *how to reproduce* the bug
@ -69,7 +69,7 @@ Don't be intimidated by these responsibilities, they are easy to meet if you tak
- [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] Add tests for your feature that prove it's working as expected. Code coverage should not drop below its 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.