diff --git a/templates/README.md b/templates/README.md new file mode 100644 index 0000000..25d4780 --- /dev/null +++ b/templates/README.md @@ -0,0 +1,22 @@ +## Template files + +When creating a repository, it can be helpful to start with a template instead of a blank page. Here are some of our favorite resources, templates, and examples for important files in GitHub Repositories. + +- [Make a README.md](https://www.makeareadme.com/) +- [.gitignore](https://github.com/github/gitignore) +- [Support Protips: Best practices for protected branches](https://github.community/t5/Support-Protips/Best-practices-for-protected-branches/ba-p/10224) +- [General collaboration best practices](https://github.com/ideaconsult/etc/wiki/GitHub-Collaboration-Best-Practices) + +# Templates + +- [Awesome README.md examples](https://github.com/matiassingers/awesome-readme) +- [Contributing guides](https://github.com/mntnr/awesome-contributing) +- [Issue & Pull Request templates](https://github.com/devspace/awesome-github-templates) +- [GitHub's default bug report template](github-bug.md) +- [GitHub's default feature suggestion template](github-feature.md) +- [Atom's bug report template](atom-bug.md) +- [Atom's feature request template](atom-feature.md) + +# Documentation + +- Issue and PR templates for [GitHub.com](https://help.github.com/en/articles/about-issue-and-pull-request-templates) and for [GitHub Enterprise Server](https://help.github.com/en/enterprise/user/articles/about-issue-and-pull-request-templates) \ No newline at end of file diff --git a/templates/atom-bug.md b/templates/atom-bug.md new file mode 100644 index 0000000..447078b --- /dev/null +++ b/templates/atom-bug.md @@ -0,0 +1,48 @@ +```markdown +--- +name: Bug report +about: Create a report to help us improve + +--- + + + +### Prerequisites + +* [ ] Put an X between the brackets on this line if you have done all of the following: + * Reproduced the problem in Safe Mode: https://flight-manual.atom.io/hacking-atom/sections/debugging/#using-safe-mode + * Followed all applicable steps in the debugging guide: https://flight-manual.atom.io/hacking-atom/sections/debugging/ + * Checked the FAQs on the message board for common solutions: https://discuss.atom.io/c/faq + * Checked that your issue isn't already filed: https://github.com/issues?utf8=✓&q=is%3Aissue+user%3Aatom + * Checked that there is not already an Atom package that provides the described functionality: https://atom.io/packages + +### Description + +[Description of the issue] + +### Steps to Reproduce + +1. [First Step] +2. [Second Step] +3. [and so on...] + +**Expected behavior:** [What you expect to happen] + +**Actual behavior:** [What actually happens] + +**Reproduces how often:** [What percentage of the time does it reproduce?] + +### Versions + +You can get this information from copy and pasting the output of `atom --version` and `apm --version` from the command line. Also, please include the OS and what version of the OS you're running. + +### Additional Information + +Any additional information, configuration or data that might be necessary to reproduce the issue. +``` \ No newline at end of file diff --git a/templates/atom-feature.md b/templates/atom-feature.md new file mode 100644 index 0000000..5307416 --- /dev/null +++ b/templates/atom-feature.md @@ -0,0 +1,43 @@ +```markdown +--- +name: Feature request +about: Suggest an idea for this project + +--- + + + +## Summary + +One paragraph explanation of the feature. + +## Motivation + +Why are we doing this? What use cases does it support? What is the expected outcome? + +## Describe alternatives you've considered + +A clear and concise description of the alternative solutions you've considered. Be sure to explain why Atom's existing customizability isn't suitable for this feature. + +## Additional context + +Add any other context or screenshots about the feature request here. +``` \ No newline at end of file diff --git a/templates/github-bug.md b/templates/github-bug.md new file mode 100644 index 0000000..e1d0e1e --- /dev/null +++ b/templates/github-bug.md @@ -0,0 +1,40 @@ +```markdown +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. +``` \ No newline at end of file diff --git a/templates/github-feature.md b/templates/github-feature.md new file mode 100644 index 0000000..ae9717f --- /dev/null +++ b/templates/github-feature.md @@ -0,0 +1,22 @@ +```markdown +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. +```