From e8bf58357da3fb52d81498092a58fbc1f77912a9 Mon Sep 17 00:00:00 2001 From: tycrek Date: Sat, 31 Jul 2021 10:56:24 -0600 Subject: [PATCH] improved PR template & added Contributing Guidelines --- .github/PULL_REQUEST_TEMPLATE.md | 18 +++++++----------- CONTRIBUTING.md | 8 ++++++++ 2 files changed, 15 insertions(+), 11 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b3a03b7..f50d028 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,17 +1,8 @@ ---- -name: Pull Request -about: Contribute to the project -title: "Title" -assignees: 'tycrek' -projects: 1 - ---- - ## Checklist -- [x] I have read the Contributing Guidelines (coming soon) -- [ ] I acknowledge that any submitted code will be licensed under the [ISC License](https://github.com/tycrek/ass/blob/master/LICENSE) +- [ ] I have read the [Contributing Guidelines] +- [ ] I acknowledge that any submitted code will be licensed under the [ISC License] - [ ] I confirm that submitted code is my own work - [ ] I have tested the code, and confirm that it works @@ -24,3 +15,8 @@ projects: 1 ## Description + + + +[Contributing Guidelines]: https://github.com/tycrek/ass/blob/master/CONTRIBUTING.md +[ISC License]: https://github.com/tycrek/ass/blob/master/LICENSE diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..685fd5c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,8 @@ +# Contributing Guidelines + +###### Last revised: July 31st, 2021 + +1. **English only** in Issues & Pull Requests. +2. Code should be tested before submitting. +3. Code style should be consistent with the rest of the project. +4. Use comments to help explain code.