From faa6ab70c0364d1e1f83d7d9a2a08c7ba68e964c Mon Sep 17 00:00:00 2001 From: Kevin Sacro Date: Sun, 19 Nov 2023 00:28:56 -0700 Subject: [PATCH 1/2] Create CONTRIBUING.md Added first version of contribution guidelines --- CONTRIBUING.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 CONTRIBUING.md diff --git a/CONTRIBUING.md b/CONTRIBUING.md new file mode 100644 index 0000000..64fd5a7 --- /dev/null +++ b/CONTRIBUING.md @@ -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 + + From d18c9aca2a4bc41bba1a5e34a24e6e0d554ae03f Mon Sep 17 00:00:00 2001 From: Kevin Sacro Date: Sun, 19 Nov 2023 00:33:47 -0700 Subject: [PATCH 2/2] Rename CONTRIBUING.md to CONTRIBUTING.md --- CONTRIBUING.md => CONTRIBUTING.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename CONTRIBUING.md => CONTRIBUTING.md (100%) diff --git a/CONTRIBUING.md b/CONTRIBUTING.md similarity index 100% rename from CONTRIBUING.md rename to CONTRIBUTING.md