mirror of
https://github.com/hodgef/simple-keyboard.git
synced 2025-03-03 16:02:56 +08:00
Create CONTRIBUTING.md
This commit is contained in:
parent
65de51b1df
commit
86b622a812
15
CONTRIBUTING.md
Normal file
15
CONTRIBUTING.md
Normal file
@ -0,0 +1,15 @@
|
||||
# Contributing
|
||||
|
||||
When contributing to this repository, please first discuss the change you wish to make via issue,
|
||||
email, or any other method with the owners of this repository before working on a change.
|
||||
|
||||
Please note we have a code of conduct, please follow it in all your interactions with the project.
|
||||
|
||||
## Pull Request Guidelines
|
||||
|
||||
1. Please ensure your proposal will not radically change current functionality or bring along breaking changes.
|
||||
2. PRs only consisting of typo fixes (or other automated contributions), will not be accepted.
|
||||
3. Do not add any dependencies to the project.
|
||||
4. Document your changes thoroughly.
|
||||
5. Ensure coverage is complete (`npm run coverage` should show 100% coverage) and that none of the tests fail.
|
||||
6. Be reactive to any comments, reviews or change requests entered in your pull request.
|
Loading…
Reference in New Issue
Block a user