Skip to content

Commit

Permalink
Merge pull request #6 from kesac/dev-contributor-guidelines
Browse files Browse the repository at this point in the history
Added first version of contributor guidelines
  • Loading branch information
kesac authored Nov 20, 2023
2 parents 8d5b36b + d18c9ac commit b8bdaed
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
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


0 comments on commit b8bdaed

Please sign in to comment.