Merge pull request #765 from github/parkerbxyz-updates

Author: parkerbxyz

Diff for: .github/ISSUE_TEMPLATE.md

@@ -1,26 +1,32 @@
 ## Overview
-**TL;DR**
-<One to two sentence description of the issue you are encountering or trying to solve.>
 
-### Extra Detail
+<!-- One to two sentence description of the issue you are encountering or trying to solve. -->
 
+### Extra detail
+
+<!-- Please include any additional details that may be helpful in understanding the issue. -->
 #### Screenshots
-<If bug fix, please upload images of the error to better showcase the problem.>
+
+<!-- If bug fix, please upload images of the error to better showcase the problem. -->
 
 #### Reasoning
-<If new idea or direction, please create a checklist of proposed ideas or next steps. [Example](https://github.com/github/training-kit/issues/415).>
-
-### How to Contribute
-- [ ] Comment on this issue if you'd like to work/collaborate on it!
-- [ ] Fork the [repository](https://github.com/github/training-kit).
-- [ ] Use the [GitHub Flow](https://guides.github.com/introduction/flow/) to make changes to your fork. [This](https://lab.github.com/githubtraining/introduction-to-github) is a refresher course if you're unsure about how to make a change on GitHub.
-- [ ] Push your changes to your repository.
-- [ ] Submit a Pull Request
+
+<!-- If new idea or direction, please create a checklist of proposed ideas or next steps. [Example](https://github.com/github/training-kit/issues/415). -->
+
+### How to contribute
+
+- Comment on this issue if you'd like to work/collaborate on it!
+- Fork the [repository](https://github.com/github/training-kit).
+- Use the [GitHub Flow](https://guides.github.com/introduction/flow/) to make changes to your fork. [This](https://github.com/skills/introduction-to-github) is a refresher course if you're unsure about how to make a change on GitHub.
+- Push your changes to your repository.
+- Submit a Pull Request
   - Base Dropdown: github/training-kit
   - Compare Dropdown: Your fork
 
-#### Testing Locally
+#### Testing locally
+
 If you'd like to make and test changes locally (and see how they would look if merged), do the following:
+
 - In your command line:
   - [Install Git](https://git-scm.com/)
   - [Install Ruby](https://www.ruby-lang.org/en/documentation/installation/)
@@ -29,4 +35,5 @@ If you'd like to make and test changes locally (and see how they would look if m
     - When successful, the script will initiate a local server at `http://127.0.0.1:4000/`.
 
 ### Questions?
+
 - Leave a comment on this issue! Make sure to use `@mentions` if you want a specific person's attention!

Diff for: .github/PULL_REQUEST_TEMPLATE.md

@@ -1,14 +1,19 @@
 ## Overview
-**TL;DR**
-<One to two sentence description of the issue you are encountering or trying to solve.>
 
-<Link to related issue. Type `closes #RELATEDISSUENUMBER` to establish a link.>
+<!--
+One to two sentence description of the issue you are encountering or trying to solve.
 
-### Questions
-<If relevant, write a list of questions that you would like to discuss related to the changes that you have made.>
+Link to related issue. Type `closes #RELATED_ISSUE_NUMBER` to establish a link.
+-->
 
-### Next Steps
-<If incomplete, create a task list of items that are still being worked on within the Pull Request.>
+## Questions
 
-### Review
-<If complete, or ready for :eyes:, use @mentions for quick questions, specific feedback, and progress updates.>
+<!-- If relevant, write a list of questions that you would like to discuss related to the changes that you have made. -->
+
+## Next steps
+
+<!-- If incomplete, create a task list of items that are still being worked on within the Pull Request. -->
+
+## Review
+
+<!-- If complete, or ready for :eyes:, use @mentions for quick questions, specific feedback, and progress updates. -->

Diff for: .github/workflows/jekyll.yml

@@ -10,6 +10,11 @@ jobs:
     steps:
     - uses: actions/checkout@v2
 
+    # Node-specific steps
+    - name: Install node modules
+      run: |
+        npm install
+
     # Ruby-specific steps
     - name: Set up Ruby 2.6
       uses: actions/setup-ruby@v1
@@ -21,14 +26,9 @@ jobs:
         bundle install --jobs 4 --retry 3
         bundle exec rake
 
-    # Node-specific steps
-    - name: Install node modules
-      run: |
-        npm install
-
     # Jekyll-specific steps
     - name: Build the site in the jekyll/builder container
       run: |
         docker run \
         -v ${{ github.workspace }}:/srv/jekyll -v ${{ github.workspace }}/_site:/srv/jekyll/_site \
-        jekyll/builder:latest /bin/bash -c "chmod a+w /srv/jekyll/Gemfile.lock && chmod 777 /srv/jekyll && jekyll build --future"
+        jekyll/builder:latest /bin/bash -c "chmod a+w /srv/jekyll/Gemfile.lock && chmod 777 /srv/jekyll && jekyll build --future"

Diff for: CONTRIBUTING.md

@@ -1,53 +1,53 @@
 # Contributing to training-kit
 
-:tada: Thank you for taking the time to contribute and for seeking out these instructions. We :heart: community contributions to these materials.
+🎉 Thank you for taking the time to contribute and for seeking out these instructions. We :heart: community contributions to these materials.
 
-<hr>
+---
 
 ## Code of Conduct
 
 This project and everyone who participates in it is governed by the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [services@github.com](mailto:services@github.com).
 
-<hr>
+---
 
 ## What should I know before I get started?
 
 ### The goal of these resources
 
-These materials are designed to help those new to Git, GitHub and software development as a whole. By using these cheatsheets, we hope users will:
+These materials are designed to help those new to Git, GitHub and software development as a whole. By using these materials, we hope users will:
 
 - Feel welcome and become active contributors in the open source community
-- Learn best practices for using Git, GitHub and other GitHub supported projects such as Electron, Atom, etc
+- Learn best practices for using Git and GitHub
 - Learn how to use the applications within GitHub's ecosystem to build better software
 
 ### Types of contributions we love
 
 We're always looking for contributions to help improve these resources. This includes:
 
-- Improving the existing cheatsheets
-- Translations of existing cheatsheets into new languages
-- Adding new classes or resources aligned with the [goals](#the-goal-of-these-resources)
+- Improving the existing cheat sheets
+- Translations of existing cheat sheets into new languages
+- Adding new courseware or resources aligned with the [goals](#the-goal-of-these-resources)
 
-<hr>
+---
 
 ## How to contribute
 
 ### Report a bug
 
 Oops, thanks for finding that! If you know how to fix it, please feel free to fork the repository and submit a change via Pull Request.
 
-If you aren't sure how to fix it or just don't have time, we invite you to open a [new Issue](https://github.com/github/training-kit/issues/new). Please be sure to provide information so we can recreate the error.
+If you aren't sure how to fix it or just don't have time, we invite you to open a [new Issue](https://github.com/github/training-kit/issues/new). Please be sure to provide information, so we can recreate the error.
 
 ### Translate existing resources
 
-Several community members have been kind enough to translate the Git Cheat Sheets into various languages. At this time, we are only set up to serve the cheat sheets in various languages (but maybe you can help us change that :wink:) If you are planning to contribute a translation, please do the following:
+Several community members have been kind enough to translate the Git Cheat Sheets into various languages. At this time, we are only set up to serve the cheat sheets in various languages (but maybe you can help us change that 😉). If you are planning to contribute a translation, please do the following:
 
 - Fork this repository
-- Create a new folder in the [downloads directory](https://github.com/github/training-kit/tree/master/downloads) using the standard abbreviation for the language you are providing.
-- Copy the most recent [English version of the cheatsheet](https://github.com/github/training-kit/blob/master/downloads/github-git-cheat-sheet.md) to the folder you created.
+- Create a new folder in the [downloads directory](https://github.com/github/training-kit/tree/main/downloads) using the standard abbreviation for the language you are providing.
+- Copy the most recent [English version of the cheat sheet](https://github.com/github/training-kit/blob/main/downloads/github-git-cheat-sheet.md) to the folder you created.
 - Complete the translation
-- Add a link to the translated resource on [/index.html](https://github.com/github/training-kit/blob/master/index.html)
-- Open a pull request against the `master` branch of this repository.
+- Add a link to the translated resource on [/index.html](https://github.com/github/training-kit/blob/main/index.html)
+- Open a pull request against the `main` branch of this repository.
 - Be sure to @ mention a couple of your friends who are native speakers and ask them to review the translation.
 - Update your translation based on feedback from your friends.
 
@@ -63,7 +63,7 @@ When you are contributing something new, we ask you to be familiar with our cont
 
 If you just want to help out, but don't have a particular change in mind, check out the [open issues](https://github.com/github/training-kit/issues) for projects you can tackle, review an [open pull request](https://github.com/github/training-kit/pulls), or check out [the project ROADMAP](https://github.com/github/training-kit/projects/1).
 
-<hr>
+---
 
 ### Styling content
 
@@ -81,4 +81,4 @@ To build the materials do the following:
 1. Run `script/build` to build the site
 1. Run `script/server`
     - When successful, the script will initiate a local server at `http://127.0.0.1:4000/`.
-1. Simply paste that into your favorite web-browser and you will be ready to test
+1. Simply paste that into your favorite web-browser, and you will be ready to test

Diff for: Gemfile

@@ -1,7 +1,7 @@
 source "https://rubygems.org"
 
-gem 'github-pages', '~> 219', group: :jekyll_plugins
+gem 'github-pages', group: :jekyll_plugins
 gem 'html-proofer'
-gem 'rack-contrib', '~> 1.1.0'
+gem 'rack-contrib'
 gem 'rake'
 gem 'jekyll-octicons'