├── README.md └── .github ├── ISSUE_TEMPLATE ├── FEATURE_REQUEST.md └── BUG_REPORT.md └── PULL_REQUEST_TEMPLATE.md /README.md: -------------------------------------------------------------------------------- 1 | # .github 2 | Default community health files for Codegram projects 3 | 4 | For more information, please see the article on [creating a default community health file for your organization](https://docs.github.com/en/github/building-a-strong-community/creating-a-default-community-health-file). 5 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "\U0001F680 Feature Request" 3 | about: "I have a suggestion (and may want to implement it \U0001F642)!" 4 | title: "" 5 | labels: "i: enhancement, i: needs triage" 6 | assignees: "" 7 | --- 8 | 9 | ## 🦄 Feature Request 10 | 11 | ### Is your feature request related to a problem? 12 | 13 | A clear and concise description of what the problem is. Ex. I have an issue when [...] 14 | 15 | ### Describe the solution you'd like 16 | 17 | A clear and concise description of what you want to happen. Add any considered drawbacks. 18 | 19 | ### Describe alternatives you've considered 20 | 21 | A clear and concise description of any alternative solutions or features you've considered. 22 | 23 | ### Teachability, Documentation, Adoption, Migration Strategy 24 | 25 | If you can, explain how users will be able to use this and possibly write out a version the docs. 26 | Maybe a screenshot or design? 27 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/BUG_REPORT.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: "\U0001F41B Bug Report" 3 | about: "If something isn't working as expected \U0001F914." 4 | title: "" 5 | labels: "i: bug, i: needs triage" 6 | assignees: "" 7 | --- 8 | 9 | ## 🐞 Bug Report 10 | 11 | ### Steps to reproduce 12 | 13 | How can we reproduce the bug? Example: 14 | - Go here 15 | - Go there 16 | - Click there 17 | 18 | ### Current Behavior 19 | 20 | Which broken behavior are you experiencing? 21 | 22 | ### Expected behavior 23 | 24 | A clear and concise description of what you expected to happen. 25 | 26 | ### Input Code 27 | 28 | Please attach any code that could help replicate the behavior. 29 | 30 | ### Environment 31 | 32 | Please describe any relevant context that might be useful in order to debug the issue. Examples are language/library versions, browser, etc. 33 | 34 | ### Possible Solution 35 | 36 | Only if you have suggestions on a fix for the bug 37 | 38 | ### Additional context/Screenshots 39 | 40 | Add any other context about the problem here. If applicable, add screenshots to help explain. 41 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## ✍️ Description 2 | 3 | (required) Please include any relevant details about this Pull Request, with a focus on: 4 | 5 | - _What_ does it fix. 6 | - _Why_ did you do things this way. 7 | - _How_ does it fix the issue at hand. 8 | 9 | Please don't be shy and add as much context as you think necessary. 10 | 11 | ## ✅ Fixes 12 | 13 | (optional) 14 | 15 | - Closes #(issue) 16 | - Fixes #(issue) 17 | 18 | ## ✅ QA 19 | 20 | Before requesting a review, please make sure that: 21 | 22 | - [ ] Preview is working on Netlify, Heroku or similar. 23 | - [ ] Manually check that it's working. 24 | - [ ] Add documentation and tests if needed. 25 | 26 | ## 📸 Screenshots 27 | 28 | (optional) Please post any relevant screenshots that might help understanding the scope of this functionality. 29 | 30 | ## 🔗 Relevant URLs 31 | 32 | (optional) 33 | 34 | * https://example.com/feature/1 35 | * https://example.com/feature/2 36 | 37 | ## 📕Extra Documentation 38 | 39 | (optional) 40 | 41 | Please include links to any external documentation such as requirements, manuals, etc. 42 | --------------------------------------------------------------------------------