-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from kesac/dev-contributor-guidelines
Added first version of contributor guidelines
- Loading branch information
Showing
1 changed file
with
33 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Contributor Guidelines | ||
Thanks for your interest in this project. By contributing to this project, you agree that your contributions will be licensed under Syllabore's open source license. | ||
|
||
## Can I submit pull requests? | ||
Yes, please create pull requests for: | ||
- 🚲 Small enhancements | ||
- 🐛 Bug fixes | ||
- 🌿 Example code for use in documentation | ||
|
||
Your pull requests must: | ||
- Be small and easy to review | ||
- Contain a description of what is changing and why it needs to be addressed | ||
- Have a concise title | ||
|
||
Your code contributions must: | ||
- Follow the existing style of the project as best as possible | ||
- Be easy to read | ||
- Be easy to test | ||
- Not introduce new dependencies | ||
- Respect the existing project structure: | ||
- `/Syllabore/` - the class library | ||
- `/Syllabore.Example/` - the project for example code, especially those referenced in the wiki | ||
- `/Syllabore.Tests/` - the project for unit tests | ||
|
||
## Can I submit issues? | ||
Yes, please create new issues for: | ||
- 🐜 Bugs you encounter | ||
- 🚗 Feature requests (for someone else to implement) | ||
- 🏎 Proposals for features you want to vet before implementing | ||
- 📘 Anything related to documentation | ||
- ❓ General questions | ||
|
||
|