mirrors/personal-security-checklist
1
0
Fork 0
mirror of https://github.com/Lissy93/personal-security-checklist.git synced 2024-12-22 16:15:04 +07:00
Code Issues Packages Projects Releases Wiki Activity

Updates PR template, and contributing guidelines

Browse Source
This commit is contained in:
Alicia Sykes 2024-02-10 23:07:25 +00:00
parent 8a03cb2b24
commit b2a7b60f71
3 changed files with 36 additions and 266 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
.github/CONTRIBUTING.md vendored
View File

@ -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. 💖<br>
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**

240
.github/CONTRIBUTORS.svg vendored
View File

File diff suppressed because one or more lines are too long
Side by Side

Before

Width:  |  Height:  |  Size: 14 MiB

39
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -1,25 +1,26 @@
<!--
Thank you for contributing the The Personal Security Checklist 🫶
So that your PR can be reviewed quickly, please complete the following sections:
-->
> 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
<!-- Indicate the type of PR (delete as necessary) -->
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
<!-- Briefly outline your new changes -->
### Overview
> Briefly outline your new changes...
#### Issue Number _(if applicable)_
<!-- If this PR is related to an issue, please include ticket number. -->
### Issue Number _(if applicable)_
> If this PR is related to an issue, please include ticket number.
#### Supporting Material _(if applicable)_
<!-- For any content changes, additions or deletions, please include links to relevant references or supported materials -->
### 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)_
<!-- If you are affiliated with a product or service that relates to this PR, please disclose this for transparency -->
### 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
<!-- Please complete the following 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)