From a0619aadc8f4892766595030661e7d0e82326c20 Mon Sep 17 00:00:00 2001 From: hkambow Date: Thu, 10 Sep 2020 18:08:30 -0600 Subject: [PATCH 1/9] creating pull request template pull request template --- pull_request_template.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 pull_request_template.md diff --git a/pull_request_template.md b/pull_request_template.md new file mode 100644 index 0000000..92d0eb1 --- /dev/null +++ b/pull_request_template.md @@ -0,0 +1,10 @@ +## Contribution Guidelines +Welcome to Section’s Engineering Education program. This program is dedicated to providing a community-generated pool of educational content that is useful for engineers of every level. To begin, we’d recommend reviewing our most recently published content at section.io/engineering-education/ to get a sense of: + +- Article structures +- Type of content that has been contributed +- Topics you can begin working on + +Articles do not need to be Section-specific or strongly Section-related. This is not necessarily about Section or Edge Compute directly, but rather an effort to provide educational value to software developers within the diverse ecosystem of web technologies. + +**Articles should be a minimum of 750 words.** From 8ab1e2f0aa4e1dcf340406dcf8cd040777fa5e69 Mon Sep 17 00:00:00 2001 From: hkambow Date: Thu, 10 Sep 2020 18:09:50 -0600 Subject: [PATCH 2/9] change file path place file into github folder --- pull_request_template.md => .github/pull_request_template.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename pull_request_template.md => .github/pull_request_template.md (100%) diff --git a/pull_request_template.md b/.github/pull_request_template.md similarity index 100% rename from pull_request_template.md rename to .github/pull_request_template.md From ccba13987e0e13baf6e981d3e6bc51f9a4e0e59e Mon Sep 17 00:00:00 2001 From: hkambow Date: Thu, 10 Sep 2020 18:32:43 -0600 Subject: [PATCH 3/9] changes to info info --- .github/pull_request_template.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 92d0eb1..fbfdf56 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,10 +1,24 @@ +If this is your 1st PR - read the paragraph below carefully. + +Feel free to delete the bottom text - if this is NOT your 1st PR. + ## Contribution Guidelines -Welcome to Section’s Engineering Education program. This program is dedicated to providing a community-generated pool of educational content that is useful for engineers of every level. To begin, we’d recommend reviewing our most recently published content at section.io/engineering-education/ to get a sense of: +Ensure all article submissions are pre-checked for English grammar technically accurate, and delivered under the assertion that the content is original to you and includes proper citations (including sourced images). + +Before submitting your article, we request that you cross-check the readability of your content using this free tool. This check helps make your writing BOLD & CLEAR by calling attention to any lengthy, complex sentences and common errors. If you see a yellow sentence, you may want to shorten or split it. + +These guidelines are intended to help EngEd contributors grow as authors and to enrich the larger engineering community as a whole by continuing to create higher quality educational articles, tutorials, how-to’s,technology reviews, etc. + +Communicating your key takeaways +Articles should be clear, accurate, and fully explained. We are more interested in substance than length, and supporting examples are always encouraged. At the same time, articles that include mostly code with very little narrative lack sufficient depth and guidance for the audience to fully grasp important concepts. + +We suggest you think about what is most important to your article or any pain point you are addressing. Assume the audience is smart but has no prior exposure to the common terminology in your article. -- Article structures -- Type of content that has been contributed -- Topics you can begin working on +For example: +If your article is about serving ML models with Django, then the reader should have a decent understanding of something like: -Articles do not need to be Section-specific or strongly Section-related. This is not necessarily about Section or Edge Compute directly, but rather an effort to provide educational value to software developers within the diverse ecosystem of web technologies. +The structure of a django app +How to use such an app to serve a model for inference +The details your article gives should help further grow the readers’ skills as they practice on their own projects. **Articles should be a minimum of 750 words.** From 7b89939d6693ae6174d5f69f7f1243cc512e17a8 Mon Sep 17 00:00:00 2001 From: hectorkambow <60800358+hectorkambow@users.noreply.github.com> Date: Thu, 10 Sep 2020 20:14:11 -0600 Subject: [PATCH 4/9] submitting 1st article submitting 1st article --- adding-article.md | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 adding-article.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 From f886696310a42fe398735fc1cb125f548826c17a Mon Sep 17 00:00:00 2001 From: hkambow Date: Thu, 10 Sep 2020 20:54:00 -0600 Subject: [PATCH 5/9] update to template info info update --- .github/pull_request_template.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index fbfdf56..db86c65 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -3,11 +3,14 @@ If this is your 1st PR - read the paragraph below carefully. Feel free to delete the bottom text - if this is NOT your 1st PR. ## Contribution Guidelines -Ensure all article submissions are pre-checked for English grammar technically accurate, and delivered under the assertion that the content is original to you and includes proper citations (including sourced images). +In order to achieve a level of consistent style and increasingly elevated quality, we have created this document to help new contributors. Let's start by reviewing what's needed. -Before submitting your article, we request that you cross-check the readability of your content using this free tool. This check helps make your writing BOLD & CLEAR by calling attention to any lengthy, complex sentences and common errors. If you see a yellow sentence, you may want to shorten or split it. +Ensure all article submissions are pre-checked for English grammar technically accurate and delivered under the assertion that the content is original to you and includes proper citations (including sourced images). -These guidelines are intended to help EngEd contributors grow as authors and to enrich the larger engineering community as a whole by continuing to create higher quality educational articles, tutorials, how-to’s,technology reviews, etc. +Before submitting your article, we request that you cross-check the readability of your content using this free tool. +http://www.hemingwayapp.com/ + +This check helps make your writing BOLD & CLEAR by calling attention to any lengthy, complex sentences and common errors. If you see a yellow sentence, you may want to shorten or split it. Communicating your key takeaways Articles should be clear, accurate, and fully explained. We are more interested in substance than length, and supporting examples are always encouraged. At the same time, articles that include mostly code with very little narrative lack sufficient depth and guidance for the audience to fully grasp important concepts. @@ -17,8 +20,8 @@ We suggest you think about what is most important to your article or any pain po For example: If your article is about serving ML models with Django, then the reader should have a decent understanding of something like: -The structure of a django app +The structure of a Django app How to use such an app to serve a model for inference The details your article gives should help further grow the readers’ skills as they practice on their own projects. -**Articles should be a minimum of 750 words.** +Articles should be a minimum of 750 words. From 5fd38c1b7d5b3e07c52cabe97d00f4170d6c84e1 Mon Sep 17 00:00:00 2001 From: hkambow Date: Thu, 10 Sep 2020 21:05:05 -0600 Subject: [PATCH 6/9] updating text instructions with repl --- .github/pull_request_template.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index db86c65..9da158d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,4 +1,4 @@ -If this is your 1st PR - read the paragraph below carefully. +## If this is your 1st PR - Review the paragraph below carefully. Feel free to delete the bottom text - if this is NOT your 1st PR. @@ -7,11 +7,16 @@ In order to achieve a level of consistent style and increasingly elevated qualit Ensure all article submissions are pre-checked for English grammar technically accurate and delivered under the assertion that the content is original to you and includes proper citations (including sourced images). -Before submitting your article, we request that you cross-check the readability of your content using this free tool. +Before submitting your article, we request that you cross-check the readability of your content using this free tool. http://www.hemingwayapp.com/ This check helps make your writing BOLD & CLEAR by calling attention to any lengthy, complex sentences and common errors. If you see a yellow sentence, you may want to shorten or split it. +For Code Snippets: +https://repl.it/ +Repl.it is an interactive programming environment and you can link those code examples into your articles. +Use it on any code examples to be included in future articles to allow the audience a chance to test and play with the code you are referencing. + Communicating your key takeaways Articles should be clear, accurate, and fully explained. We are more interested in substance than length, and supporting examples are always encouraged. At the same time, articles that include mostly code with very little narrative lack sufficient depth and guidance for the audience to fully grasp important concepts. From db6ff002ed4ab3d90786c8138519a74629b22f14 Mon Sep 17 00:00:00 2001 From: Louise Date: Fri, 11 Sep 2020 19:07:21 +0100 Subject: [PATCH 7/9] Modified PR Template to Checkboxes Modified PR Template to Checkboxes --- .github/pull_request_template.md | 49 +++++++++++++------------------- 1 file changed, 19 insertions(+), 30 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9da158d..0224a53 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,32 +1,21 @@ -## If this is your 1st PR - Review the paragraph below carefully. - -Feel free to delete the bottom text - if this is NOT your 1st PR. +# Article Checklist +## Preliminary Checks +- [ ] Have you used the correct folder and file structure? - See Contribution Guidelines (link) +- [ ] 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? - [H2 (##) 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 -In order to achieve a level of consistent style and increasingly elevated quality, we have created this document to help new contributors. Let's start by reviewing what's needed. - -Ensure all article submissions are pre-checked for English grammar technically accurate and delivered under the assertion that the content is original to you and includes proper citations (including sourced images). - -Before submitting your article, we request that you cross-check the readability of your content using this free tool. -http://www.hemingwayapp.com/ - -This check helps make your writing BOLD & CLEAR by calling attention to any lengthy, complex sentences and common errors. If you see a yellow sentence, you may want to shorten or split it. - -For Code Snippets: -https://repl.it/ -Repl.it is an interactive programming environment and you can link those code examples into your articles. -Use it on any code examples to be included in future articles to allow the audience a chance to test and play with the code you are referencing. - -Communicating your key takeaways -Articles should be clear, accurate, and fully explained. We are more interested in substance than length, and supporting examples are always encouraged. At the same time, articles that include mostly code with very little narrative lack sufficient depth and guidance for the audience to fully grasp important concepts. - -We suggest you think about what is most important to your article or any pain point you are addressing. Assume the audience is smart but has no prior exposure to the common terminology in your article. - -For example: -If your article is about serving ML models with Django, then the reader should have a decent understanding of something like: - -The structure of a Django app -How to use such an app to serve a model for inference -The details your article gives should help further grow the readers’ skills as they practice on their own projects. - -Articles should be a minimum of 750 words. +For first-time contributors and for more details, see our Contributing Guidelines (link) \ No newline at end of file From e019816398cf2f211466d76c3adfe04260c37927 Mon Sep 17 00:00:00 2001 From: hkambow Date: Tue, 15 Sep 2020 18:55:15 -0600 Subject: [PATCH 8/9] adding links adding links --- .github/pull_request_template.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0224a53..229ded0 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,9 +1,9 @@ # Article Checklist ## Preliminary Checks -- [ ] Have you used the correct folder and file structure? - See Contribution Guidelines (link) +- [ ] 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? - [H2 (##) and below](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#headers) +- [ ] 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 @@ -18,4 +18,4 @@ - [ ] Have you used Repl.it for your code snippets? ## Contribution Guidelines -For first-time contributors and for more details, see our Contributing Guidelines (link) \ No newline at end of file +For first-time contributors and for more details, see our Contributing Guidelines (https://github.com/section-io/engineering-education/blob/master/CONTRIBUTING.md) From 27006ba8e8f9c7f5dc4c7d05b175d72b14b21f87 Mon Sep 17 00:00:00 2001 From: hkambow Date: Tue, 15 Sep 2020 19:38:07 -0600 Subject: [PATCH 9/9] Update issue templates feat --- .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md 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.