diff --git a/README.md b/README.md index 13fe345..242859d 100644 --- a/README.md +++ b/README.md @@ -52,11 +52,11 @@ -Open Source Software is not about the code in the first place but the communications and community. People love good documentation and obvious workflows. If your software solves some problem, but nobody can figure out how to use it or, for example, how to create an effective bug report, there's something very bad going on. Did you hear about Readme Driven Development? Check out the awesome [artice written by GitHub co-founder Tom Preston-Werner](https://tom.preston-werner.com/2010/08/23/readme-driven-development.html). +Open Source Software is not about the code in the first place but the communications and community. People love good documentation and obvious workflows. If your software solves some problem, but nobody can figure out how to use it or, for example, how to create an effective bug report, there's something very bad going on. Did you hear about Readme Driven Development? Check out the awesome [article written by GitHub co-founder Tom Preston-Werner](https://tom.preston-werner.com/2010/08/23/readme-driven-development.html). -There are many great README or issues templates available on GitHub, however, you have to find them yourself and combine different templates yourself. In addition, if you want extensive docs like CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md or even advanced GitHub features like pull request template, additional labels, code scanning, and automatic issues/PRs closing and locking you have to do much work. Your time should be focused on creating something **amazing**. You shouldn't be doing the same tasks over and over like creating your GitHub project template from scratch. Follow the **don’t repeat yourself** principle. So just use the template **and go create something amazing**! +There are many great README or issues templates available on GitHub, however, you have to find them yourself and combine different templates yourself. In addition, if you want extensive docs like CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md or even advanced GitHub features like a pull request template, additional labels, code scanning, and automatic issue/PR closing and locking you have to do much more work. Your time should be focused on creating something **amazing**. You shouldn't be doing the same tasks over and over like creating your GitHub project template from scratch. Follow the **don’t repeat yourself** principle. Use a template **and go create something amazing**! -The key features of **Amazing GitHub Template**: +Key features of **Amazing GitHub Template**: - Configurable README.md template - Configurable LICENSE template @@ -78,7 +78,7 @@ The key features of **Amazing GitHub Template**: This project is the result of huge research. I'm a long-time GitHub user so I've seen more than [7.3k](https://github.com/dec0dOS?tab=stars) READMEs so far. I've started writing docs for my open source projects (that are currently in their early stages so they exist in the private space for now). After I've analyzed many popular GitHub READMEs and other GitHub-related docs and features I've tried to create a general-propose template that may be useful for any project. -Of course, no template will serve all the projects since your needs may be different. So the [Cookiecutter](https://github.com/cookiecutter/cookiecutter) comes to the rescue. It allows [Jinja template language](https://jinja.palletsprojects.com) to be used for complex cases. Just enter up the project preferences you want in the Cookiecutter interactive menu and that's it. There is a manual setup that could be useful for your existing projects (or if you don't want to use Cookiecutter for some reason). **This README.md file is not a template itself**, you should [download the precompiled template](https://github.com/dec0dOS/amazing-github-template/releases/download/latest/template.zip) and replace the predefined values, then remove unused sections. +Of course, no template will serve all the projects since your needs may be different. So [Cookiecutter](https://github.com/cookiecutter/cookiecutter) comes to the rescue. It allows [Jinja template language](https://jinja.palletsprojects.com) to be used for complex cases. Just enter up the project preferences you want in the Cookiecutter interactive menu and that's it. There is a manual setup that could be useful for your existing projects (or if you don't want to use Cookiecutter for some reason). **This README.md file is not a template itself**, you should [download the precompiled template](https://github.com/dec0dOS/amazing-github-template/releases/download/latest/template.zip) and replace the predefined values, then remove unused sections. @@ -117,7 +117,7 @@ After installing Cookiecutter, all you need to do is to run the following comman cookiecutter gh:dec0dOS/amazing-github-template ``` -You will get the interactive prompt where you'll need to specify relevant options for your project (or the default value will be used). +You will get an interactive prompt where you'll specify relevant options for your project (or the default value will be used). ![Preview](docs/images/preview.svg) @@ -131,7 +131,7 @@ Please follow these steps for manual setup: `or` - Move the necessary files from precompiled template folder to your existing project directory. Don't forget .github directory that may be hidden by default in your operating system + Move the necessary files from precompiled template folder to your existing project directory. Don't forget the `.github` directory that may be hidden by default in your operating system #### Variables reference @@ -149,7 +149,7 @@ Default values are provided as an example to help you figure out what should be | OPEN_SOURCE_LICENSE | MIT license | Full OSS license name | | modern_header | y | Use HTML to prettify your header | | table_in_about | n | Use table to wrap around About section | -| include_logo | y | Include Logo section. Could only be used when `modern_header == y` | +| include_logo | y | Include Logo section. Only valid when `modern_header == y` | | include_badges | y | Include section for badges | | include_toc | y | Include Table of Contents | | include_screenshots | y | Include Screenshots section | @@ -186,7 +186,7 @@ Please try to create bug reports that are: Please adhere to this project's [code of conduct](docs/CODE_OF_CONDUCT.md). -You could use [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) to check for common markdown style inconsistency. +You can use [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) to check for common markdown style inconsistency. ## Support diff --git a/{{cookiecutter.repo_slug}}/.github/ISSUE_TEMPLATE/01_BUG_REPORT.md b/{{cookiecutter.repo_slug}}/.github/ISSUE_TEMPLATE/01_BUG_REPORT.md index 1304598..8e7b6c6 100644 --- a/{{cookiecutter.repo_slug}}/.github/ISSUE_TEMPLATE/01_BUG_REPORT.md +++ b/{{cookiecutter.repo_slug}}/.github/ISSUE_TEMPLATE/01_BUG_REPORT.md @@ -18,11 +18,11 @@ assignees: "" **Expected behavior:** - + **Steps to reproduce:** - + **Related code:** diff --git a/{{cookiecutter.repo_slug}}/.github/PULL_REQUEST_TEMPLATE.md b/{{cookiecutter.repo_slug}}/.github/PULL_REQUEST_TEMPLATE.md index ca0f5c4..5d0b0b3 100644 --- a/{{cookiecutter.repo_slug}}/.github/PULL_REQUEST_TEMPLATE.md +++ b/{{cookiecutter.repo_slug}}/.github/PULL_REQUEST_TEMPLATE.md @@ -1,16 +1,16 @@ -## Pull request type +## Pull Request type - + Please check the type of change your PR introduces: - [ ] Bugfix - [ ] Feature - [ ] Code style update (formatting, renaming) -- [ ] Refactoring (no functional changes, no api changes) -- [ ] Build related changes +- [ ] Refactoring (no functional changes, no API changes) +- [ ] Build-related changes - [ ] Documentation content changes - [ ] Other (please describe): @@ -33,8 +33,8 @@ Issue Number: N/A - [ ] Yes - [ ] No - + ## Other information - + diff --git a/{{cookiecutter.repo_slug}}/.github/labels.yml b/{{cookiecutter.repo_slug}}/.github/labels.yml index ab0a84a..6fc63e1 100644 --- a/{{cookiecutter.repo_slug}}/.github/labels.yml +++ b/{{cookiecutter.repo_slug}}/.github/labels.yml @@ -1,7 +1,7 @@ --- - name: "breaking-change" color: ee0701 - description: "A breaking change for existing users." + description: "A change that changes the API or breaks backward compatibility for users." - name: "bugfix" color: ee0701 description: "Inconsistencies or issues which will cause a problem for users or implementors." @@ -13,10 +13,10 @@ description: "Enhancement of the code, not introducing new features." - name: "refactor" color: 1d76db - description: "Improvement of existing code, not introducing new features." + description: "Updating the code with simpler, easier to understand or more efficient syntax or methods, but not introducing new features." - name: "performance" color: 1d76db - description: "Improving performance, not introducing new features." + description: "Improving performance of the project, not introducing new features." - name: "new-feature" color: 0e8a16 description: "New features or options." @@ -25,41 +25,41 @@ description: "Generic maintenance tasks." - name: "ci" color: 1d76db - description: "Work that improves the continue integration." + description: "Work that improves the continuous integration." - name: "dependencies" color: 1d76db - description: "Upgrade or downgrade of project dependencies." + description: "Change in project dependencies." - name: "in-progress" color: fbca04 - description: "Issue is currently being resolved by a developer." + description: "Issue is currently being worked on by a developer." - name: "stale" color: fef2c0 - description: "There has not been activity on this issue or PR for quite some time." + description: "No activity for quite some time." - name: "no-stale" color: fef2c0 - description: "This issue or PR is exempted from the stable bot." + description: "This is exempt from the stale bot." - name: "security" color: ee0701 - description: "Marks a security issue that needs to be resolved ASAP." + description: "Addressing a vulnerability or security risk in this project." - name: "incomplete" color: fef2c0 - description: "Marks a PR or issue that is missing information." + description: "Missing information." - name: "invalid" color: fef2c0 - description: "Marks a PR or issue that is missing information." + description: "This is off-topic, spam, or otherwise doesn't apply to this project." - name: "beginner-friendly" color: 0e8a16 - description: "Good first issue for people wanting to contribute to the project." + description: "Good first issue for people wanting to contribute to this project." - name: "help-wanted" color: 0e8a16 - description: "We need some extra helping hands or expertise in order to resolve this." + description: "We need some extra helping hands or expertise in order to resolve this!" - name: "priority-critical" color: ee0701 - description: "This should be dealt with ASAP. Not fixing this issue would be a serious error." + description: "Must be addressed as soon as possible." - name: "priority-high" color: b60205 description: "After critical issues are fixed, these should be dealt with before any further issues." @@ -72,7 +72,7 @@ - name: "major" color: b60205 - description: "This PR causes a major version bump in the version number." + description: "This PR causes a major bump in the version number." - name: "minor" color: 0e8a16 - description: "This PR causes a minor version bump in the version number." + description: "This PR causes a minor bump in the version number." diff --git a/{{cookiecutter.repo_slug}}/.github/workflows/lock.yml b/{{cookiecutter.repo_slug}}/.github/workflows/lock.yml index 714bb37..e63295d 100644 --- a/{{cookiecutter.repo_slug}}/.github/workflows/lock.yml +++ b/{{cookiecutter.repo_slug}}/.github/workflows/lock.yml @@ -16,6 +16,18 @@ jobs: github-token: ${{ github.token }} issue-lock-inactive-days: "30" issue-lock-reason: "" + issue-comment: > + Issue closed and locked due to lack of activity. + + If you encounter this same issue, please open a new issue and refer + to this closed one. pr-lock-inactive-days: "1" pr-lock-reason: "" + pr-comment: > + Pull Request closed and locked due to lack of activity. + + If you'd like to build on this closed PR, you can clone it using + this method: https://stackoverflow.com/a/14969986 + + Then open a new PR, referencing this closed PR in your message. {% endraw %} \ No newline at end of file diff --git a/{{cookiecutter.repo_slug}}/.github/workflows/stale.yml b/{{cookiecutter.repo_slug}}/.github/workflows/stale.yml index 44644c3..1f2ac56 100644 --- a/{{cookiecutter.repo_slug}}/.github/workflows/stale.yml +++ b/{{cookiecutter.repo_slug}}/.github/workflows/stale.yml @@ -21,20 +21,25 @@ jobs: stale-issue-label: "stale" exempt-issue-labels: "no-stale,help-wanted" stale-issue-message: > - There hasn't been any activity on this issue recently, so we - clean up some of the older and inactive issues. + There hasn't been any activity on this issue recently, and in order + to prioritize active issues, it will be marked as stale. Please make sure to update to the latest version and check if that solves the issue. Let us know if that works for you - by leaving a comment 👍. + by leaving a 👍 - This issue has now been marked as stale and will be closed if no - further activity occurs. Thanks! + Because this issue is marked as stale, it will be closed and locked + in 7 days if no further activity occurs. + + Thank you for your contributions! stale-pr-label: "stale" exempt-pr-labels: "no-stale" stale-pr-message: > - There hasn't been any activity on this pull request recently. This - pull request has been automatically marked as stale because of that - and will be closed if no further activity occurs within 7 days. - Thank you for your contributions. + There hasn't been any activity on this pull request recently, and in + order to prioritize active work, it has been marked as stale. + + This PR will be closed and locked in 7 days if no further activity + occurs. + + Thank you for your contributions! {% endraw %} \ No newline at end of file diff --git a/{{cookiecutter.repo_slug}}/README.md b/{{cookiecutter.repo_slug}}/README.md index dbd787f..8bf3a16 100644 --- a/{{cookiecutter.repo_slug}}/README.md +++ b/{{cookiecutter.repo_slug}}/README.md @@ -42,10 +42,10 @@ {%- endif %}
-[![license](https://img.shields.io/github/license/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}.svg?style=flat-square)](LICENSE) +[![Project license](https://img.shields.io/github/license/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}.svg?style=flat-square)](LICENSE) -[![PRs welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) -[![code with hearth by {{cookiecutter.github_username}}](https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-{{cookiecutter.github_username}}-ff1414.svg?style=flat-square)](https://github.com/{{cookiecutter.github_username}}) +[![Pull Requests welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) +[![code with love by {{cookiecutter.github_username}}](https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-{{cookiecutter.github_username}}-ff1414.svg?style=flat-square)](https://github.com/{{cookiecutter.github_username}}) {% if cookiecutter.modern_header == 'y' -%} @@ -94,7 +94,7 @@ > What problem does it (intend to) solve? > What is the purpose of your project? > Why did you undertake it? -> You don't have to answer all the questions - just the ones relevant to your project. +> You don't have to answer all the questions -- just the ones relevant to your project. {% if cookiecutter.include_screenshots == 'y' -%}
@@ -128,7 +128,7 @@ ### Installation > **[?]** -> Proceed to describe how to install and get started with the project. +> Describe how to install and get started with the project. ## Usage @@ -152,11 +152,11 @@ See the [open issues](https://github.com/{{cookiecutter.github_username}}/{{cook Reach out to the maintainer at one of the following places: {% if cookiecutter.use_github_discussions == 'y' -%} -- [GitHub discussions](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}/discussions) +- [GitHub Discussions](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}/discussions) {%- elif cookiecutter.use_github_discussions != 'y' -%} - [GitHub issues](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}/issues/new?assignees=&labels=question&template=04_SUPPORT_QUESTION.md&title=support%3A+) {%- endif %} -- The email which is located [in GitHub profile](https://github.com/{{cookiecutter.github_username}}) +- Contact options listed on [this GitHub profile](https://github.com/{{cookiecutter.github_username}}) {% if cookiecutter.include_project_assistance == 'y' -%} ## Project assistance @@ -164,8 +164,8 @@ Reach out to the maintainer at one of the following places: If you want to say **thank you** or/and support active development of {{cookiecutter.project_name}}: - Add a [GitHub Star](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}) to the project. -- Tweet about the {{cookiecutter.project_name}} on your Twitter. -- Write interesting articles about the project on [Dev.to](https://dev.to/), [Medium](https://medium.com/) or personal blog. +- Tweet about the {{cookiecutter.project_name}}. +- Write interesting articles about the project on [Dev.to](https://dev.to/), [Medium](https://medium.com/) or your personal blog. Together, we can make {{cookiecutter.project_name}} **better**! {% endif %} @@ -174,24 +174,23 @@ Together, we can make {{cookiecutter.project_name}} **better**! {% if cookiecutter.open_source_license != 'Not open source' -%} First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are **greatly appreciated**. {% endif %} -We have set up a separate document containing our [contribution guidelines](docs/CONTRIBUTING.md). -Thank you for being involved! +Please read [our contribution guidelines](docs/CONTRIBUTING.md), and thank you for being involved! {% if cookiecutter.include_authors == 'y' -%} ## Authors & contributors The original setup of this repository is by [{{cookiecutter.full_name}}](https://github.com/{{cookiecutter.github_username}}). -For a full list of all authors and contributors, check [the contributor's page](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}/contributors). +For a full list of all authors and contributors, see [the contributors page](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}/contributors). {% endif %} {% if cookiecutter.include_security == 'y' -%} ## Security -{{cookiecutter.project_name}} follows good practices of security, but 100% security can't be granted in software. +{{cookiecutter.project_name}} follows good practices of security, but 100% security cannot be assured. {{cookiecutter.project_name}} is provided **"as is"** without any **warranty**. Use at your own risk. -_For more info, please refer to the [security](docs/SECURITY.md)._ +_For more information and to report security issues, please refer to our [security documentation](docs/SECURITY.md)._ {% endif %} {% if cookiecutter.open_source_license != 'Not open source' -%} ## License diff --git a/{{cookiecutter.repo_slug}}/docs/CODE_OF_CONDUCT.md b/{{cookiecutter.repo_slug}}/docs/CODE_OF_CONDUCT.md index 72ad44b..780e938 100644 --- a/{{cookiecutter.repo_slug}}/docs/CODE_OF_CONDUCT.md +++ b/{{cookiecutter.repo_slug}}/docs/CODE_OF_CONDUCT.md @@ -30,7 +30,7 @@ Project maintainers have the right and responsibility to remove, edit, or reject ## Scope -This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. +This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. ## Enforcement diff --git a/{{cookiecutter.repo_slug}}/docs/CONTRIBUTING.md b/{{cookiecutter.repo_slug}}/docs/CONTRIBUTING.md index 713c9b4..c3c8e5b 100644 --- a/{{cookiecutter.repo_slug}}/docs/CONTRIBUTING.md +++ b/{{cookiecutter.repo_slug}}/docs/CONTRIBUTING.md @@ -22,10 +22,8 @@ To set up a development environment, please follow these steps: ## Issues and feature requests -You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by submitting an issue to our [GitHub Repository](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}/issues). Before you create an issue, make sure you search the archive, maybe your question was already answered. -{% if cookiecutter.use_github_discussions == 'y' -%} -Also please check out [GitHub discussions](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}/discussions) before submitting an issue. -{% endif %} +You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature?{% if cookiecutter.use_github_discussions == 'y' -%} Take a look at [GitHub Discussions](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}/discussions) to see if it's already being discussed. {% endif %} You can help us by [submitting an issue on GitHub](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}/issues). Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed! + Please try to create bug reports that are: - _Reproducible._ Include steps to reproduce the problem. @@ -33,19 +31,16 @@ Please try to create bug reports that are: - _Unique._ Do not duplicate existing opened issues. - _Scoped to a Single Bug._ One bug per report. -Even better: You could submit a pull request with a fix or new feature! +**Even better: Submit a pull request with a fix or new feature!** -## Pull request process +### 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 relates 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'`) +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 %} 5. Push to the branch (`git push origin feat/amazing_feature`) -6. Open a pull request - -{% if cookiecutter.use_conventional_commits == 'y' -%} -{{cookiecutter.project_name}} uses [conventional commits](https://www.conventionalcommits.org), so please follow the specification. -{% endif %} \ No newline at end of file +6. [Open a Pull Request](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.repo_slug}}/compare?expand=1) \ No newline at end of file diff --git a/{{cookiecutter.repo_slug}}/docs/SECURITY.md b/{{cookiecutter.repo_slug}}/docs/SECURITY.md index 94c0687..f25a4e9 100644 --- a/{{cookiecutter.repo_slug}}/docs/SECURITY.md +++ b/{{cookiecutter.repo_slug}}/docs/SECURITY.md @@ -2,14 +2,15 @@ ## Reporting a Vulnerability -If there are any vulnerability in **{{cookiecutter.project_name}}** project, don't hesitate to _report them_. +If there are any vulnerabilities in **{{cookiecutter.project_name}}**, don't hesitate to _report them_. 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, explain or attach it. -- In the near time, expect a reply with the required steps. Also, there may be a demand for a pull request which include the fixes. +- If you have a fix, that is most welcome -- please attach or summarize it in your message! -> You should not disclose the vulnerability publicly if you haven't received an answer in some weeks. -> If the vulnerability is rejected, you may post it publicly within some hour of rejection, unless the rejection is withdrawn within that time period. -> After the vulnerability has been fixed, you may disclose the vulnerability details publicly over some days. +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! + +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.