diff --git a/{{cookiecutter.repo_slug}}/docs/CONTRIBUTING.md b/{{cookiecutter.repo_slug}}/docs/CONTRIBUTING.md index c3c8e5b..6108b76 100644 --- a/{{cookiecutter.repo_slug}}/docs/CONTRIBUTING.md +++ b/{{cookiecutter.repo_slug}}/docs/CONTRIBUTING.md @@ -36,11 +36,11 @@ Please try to create bug reports that are: ### How to submit a Pull Request 1. Search our repository for open or closed -[Pull Requests](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}/pulls) -that relate to your submission. You don't want to duplicate effort. + [Pull Requests](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}/pulls) + that relate to your submission. You don't want to duplicate effort. 2. Fork the project 3. Create your feature branch (`git checkout -b feat/amazing_feature`) 4. Commit your changes (`git commit -m 'feat: add amazing_feature'`) {% if cookiecutter.use_conventional_commits == 'y' -%} -{{cookiecutter.project_name}} uses [conventional commits](https://www.conventionalcommits.org), so please follow the specification in your commit messages.{% endif %} + {{cookiecutter.project_name}} uses [conventional commits](https://www.conventionalcommits.org), so please follow the specification in your commit messages.{% endif %} 5. Push to the branch (`git push origin feat/amazing_feature`) -6. [Open a Pull Request](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}/compare?expand=1) \ No newline at end of file +6. [Open a Pull Request](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}/compare?expand=1) diff --git a/{{cookiecutter.repo_slug}}/docs/SECURITY.md b/{{cookiecutter.repo_slug}}/docs/SECURITY.md index f25a4e9..03d08af 100644 --- a/{{cookiecutter.repo_slug}}/docs/SECURITY.md +++ b/{{cookiecutter.repo_slug}}/docs/SECURITY.md @@ -7,10 +7,10 @@ If there are any vulnerabilities in **{{cookiecutter.project_name}}**, don't hes 1. Use any of the [private contact addresses](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}#support). 2. Describe the vulnerability. -- If you have a fix, that is most welcome -- please attach or summarize it in your message! + If you have a fix, that is most welcome -- please attach or summarize it in your message! 3. We will evaluate the vulnerability and, if necessary, release a fix or mitigating steps to address it. We will contact you to let you know the outcome, and will credit you in the report. -- Please **do not disclose the vulnerability publicly** until a fix is released! + Please **do not disclose the vulnerability publicly** until a fix is released! 4. Once we have either a) published a fix, or b) declined to address the vulnerability for whatever reason, you are free to publicly disclose it.