From b2a7b60f71fa0f215d6fb6d15d6a27538db3444c Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Sat, 10 Feb 2024 23:07:25 +0000 Subject: [PATCH] Updates PR template, and contributing guidelines --- .github/CONTRIBUTING.md | 23 ++- .github/CONTRIBUTORS.svg | 240 ------------------------------- .github/PULL_REQUEST_TEMPLATE.md | 39 ++--- 3 files changed, 36 insertions(+), 266 deletions(-) delete mode 100644 .github/CONTRIBUTORS.svg diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index bfa6854..7c8596b 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,12 +1,21 @@ # Contributing -> **Working on your first Pull Request?** You can learn more about [How to Contribute to an Open Source Project on GitHub](https://www.freecodecamp.org/news/how-to-make-your-first-pull-request-on-github-3/) - -Like most open source projects, this list exists because of contributors like yourself. +Like most open source projects, this list exists because of contributors like yourself. 💖
I would like to personally thank you for taking the time to further this list, and also for checking the contributing policy. -If you would like something added, amended or removed from this list, you can either raise an issue, or submit a pull request. -When submitting a PR to this repository, it's best to first discuss the changes with another contributor. +You can find project setup, build and deploy instructions in the [README](./README.md). -We have a [code of conduct](/.github/CODE_OF_CONDUCT.md), that is adapted from [Contributor Covenant](https://www.contributor-covenant.org/), -please follow it in all your interactions with the project. +--- + +> [!NOTE] +> **Working on your first Pull Request?** You can learn more about contributing to open source at [Git-In](https://github.com/Lissy93/git-in) + +> [!IMPORTANT] +> +> - If you're updating the checklist, the only file you need to update is `personal-security-checklist.yml`. DO NOT edit the markdown or website content directly, as this will be overridden on the next build. +> - When submitting your pull request, provide references backing up any information that you're adding/amending/removing. +> - Please ensure you've followed our [code of conduct](/.github/CODE_OF_CONDUCT.md), that is adapted from [Contributor Covenant](https://www.contributor-covenant.org/). +> - If you're adding or deleting something major, you should consider opening an issue first to discuss it. + +> [!WARNING] +> Users submitting PRs, issues or comments which are either obviously spam or activley offensive **will be reported** diff --git a/.github/CONTRIBUTORS.svg b/.github/CONTRIBUTORS.svg deleted file mode 100644 index 8405837..0000000 --- a/.github/CONTRIBUTORS.svg +++ /dev/null @@ -1,240 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9437f7c..0743e36 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,25 +1,26 @@ + -> Thank you for contributing the The Personal Security Checklist 🙌 -> So that your request can be dealt with quickly, please complete the applicable fields below and the checklist. Thank you :) +#### Category + +Checklist addition or deletion / Spelling, grammatical or link updates / website code changes / other -### Category -Software or Service Addition / Updating Security Guidelines / Formatting / Spelling or Grammar +#### Overview + -### Overview -> Briefly outline your new changes... +#### Issue Number _(if applicable)_ + -### Issue Number _(if applicable)_ -> If this PR is related to an issue, please include ticket number. +#### Supporting Material _(if applicable)_ + -### Supporting Material _(if applicable)_ -> If you are adding a software or service, please include here a link to the GitHub repo, any published security audits or other supporting material. +#### Association _(if applicable)_ + -### Association _(if applicable)_ -> If you are adding a new application or service, please indicate if you are associated with the project in anyway. - -### Checklist -> Please complete the following checklist - -- [ ] I have performed a self-review (valid markdown formatting, spelling and grammar) -- [ ] I have indicated whether I have any affiliation with any software/ services added -- [ ] I agree to follow the repositories [code of conduct](/.github/CODE_OF_CONDUCT.md) +#### Checklist + +- [ ] I have performed a self-review (valid links, formatting, spelling and grammar) +- [ ] I have indicated whether I have any affiliation with any software/ services edited +- [ ] I have read the [Contributing Guidelines](.github/CONTRIBUTING.md), and agree to follow the [Code of Conduct](/.github/CODE_OF_CONDUCT.md)