diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +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. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..229ded0 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,21 @@ +# Article Checklist +## Preliminary Checks +- [ ] Have you used the correct folder and file structure? - See Contribution Guidelines (https://github.com/section-io/engineering-education/blob/master/CONTRIBUTING.md) +- [ ] Is your article over 750 words? +- [ ] Is your article properly formatted in Markdown? - see [Github Markdown guide](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) +- [ ] Have you used our preferred heading structure? - [H3 (###) and below](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#headers) +- [ ] Does your article provide enough value and detail about your topic? Articles should be clear, accurate, and fully explained. +- [ ] Can your article be understood by beginners? Assume the audience is smart but has no prior exposure to the common terminology in your article. +- [ ] Have you included a hero image? If not, specify you'd like us to source one for you + +## Grammar Checks +- [ ] Have you spellchecked and grammar checked your article? - Tool: [Grammarly](https://grammarly.com) +- [ ] Have you checked your article for readability? - Tool: [Hemmingway](http://www.hemingwayapp.com/) +- [ ] Have you added sources for quotes and images which aren't yours? + +## Technical Checks +- [ ] Are your code snippets properly formatted for syntax highlighting - see Github Markdown guide? +- [ ] Have you used Repl.it for your code snippets? + +## Contribution Guidelines +For first-time contributors and for more details, see our Contributing Guidelines (https://github.com/section-io/engineering-education/blob/master/CONTRIBUTING.md) diff --git a/adding-article.md b/adding-article.md new file mode 100644 index 0000000..6626e9d --- /dev/null +++ b/adding-article.md @@ -0,0 +1,2 @@ +## Article test +Submitting my 1st article