Merge branch 'main' of https://[email protected]/BigDawgSwag/tra…

…ining-kit.git

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,39 @@
+## Overview
+
+<!-- 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. -->
+
+#### 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://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
+
+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/)
+  - [ ] Run `script/setup`
+  - [ ] Run `script/server`.
+    - 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!

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+## Overview
+
+<!--
+One to two sentence description of the issue you are encountering or trying to solve.
+
+Link to related issue. Type `closes #RELATED_ISSUE_NUMBER` to establish a link.
+-->
+
+## Questions
+
+<!-- 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. -->

.github/dependabot.yml

@@ -0,0 +1,17 @@
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/" 
+    schedule:
+      interval: "monthly"
+
+  # Maintain dependencies for Bundler
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "monthly"

.github/workflows/codeql.yml

@@ -0,0 +1,61 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/dependency-review.yml

@@ -0,0 +1,20 @@
+# Dependency Review Action
+#
+# This Action will scan dependency manifest files that change as part of a Pull Request, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging.
+#
+# Source repository: https://github.com/actions/dependency-review-action
+# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v3
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v2

.github/workflows/jekyll.yml

@@ -0,0 +1,73 @@
+name: Deploy Jekyll site to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+  # Runs on pull requests targeting the default branch
+  pull_request:
+    branches: [ "main" ]
+
+  # Allows us to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Set up Node
+      uses: actions/setup-node@v3
+      with:
+        node-version: 16
+        cache: 'npm'
+    - name: Install node modules
+      run: npm install
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@ece82769428359c077b5a5eaff268902a303c101
+      with:
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Set up Pages
+      id: pages
+      uses: actions/configure-pages@v2
+    - name: Build and test with Rake
+      # Only run in pull requests
+      if: github.event_name == 'pull_request'
+      run: bundle exec rake
+    - name: Build with Jekyll
+      # Don't run in pull requests
+      if: github.event_name != 'pull_request'
+      # Outputs to the './_site' directory by default
+      run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+      env:
+        JEKYLL_ENV: production
+    - name: Upload artifact
+      # Automatically uploads an artifact from the './_site' directory by default
+      uses: actions/upload-pages-artifact@v1
+
+  # Deployment job
+  deploy:
+    # Only run on pushes to the default branch
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.gitignore

@@ -0,0 +1,13 @@
+_site/
+.DS_Store
+/.rbenv-version
+/vendor/
+/bin/
+/.bundle/
+.sass-cache/
+*.*~
+_release
+*.map
+.jekyll-metadata
+node_modules/
+# *.resume-burger-jokes

.ruby-version

@@ -0,0 +1 @@
+3.1.2

CNAME

@@ -0,0 +1 @@
+training.github.com

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,84 @@
+# Contributing to training-kit
+
+🎉 Thank you for taking the time to contribute and for seeking out these instructions. We :heart: community contributions to these materials.
+
+---
+
+## 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 [[email protected]](mailto:[email protected]).
+
+---
+
+## 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 materials, we hope users will:
+
+- Feel welcome and become active contributors in the open source community
+- 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 cheat sheets
+- Translations of existing cheat sheets into new languages
+- Adding new courseware or resources aligned with the [goals](#the-goal-of-these-resources)
+
+---
+
+## 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.
+
+### 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 😉). 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/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/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.
+
+When this process is complete, we will be happy to merge the completed document.
+
+### Contribute something new
+
+Whether you have an idea to make it better, or want to contribute a whole new course or resource ... we :heart: new ideas! We invite you to open a new [Issue](https://github.com/github/training-kit/issues/new) to talk about it before you invest too much time. Of course, if you want to experiment first, you can [fork this repository](https://help.github.com/articles/working-with-forks/) and submit your idea via a Pull Request.
+
+When you are contributing something new, we ask you to be familiar with our content philosophy, the structure of the repository, and building [Jekyll](https://jekyllrb.com/) sites locally. See the sections below for more information.
+
+### Not sure where to start?
+
+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).
+
+---
+
+### Styling content
+
+This site uses GitHub's CSS toolkit called [Primer](https://github.com/primer/primer-css). It's easy to use, and if your contribution requires some design or front-end work you should check out the [Primer Docs](http://primercss.io/).
+
+For writing style guides, we lean on the [GitHub Brand Guide](https://brand.github.com/). The [Content](https://brand.github.com/content/) section is a great place to start.
+
+### Building and testing
+
+When you are ready to test your changes, you will want to build the repository locally. This is fully automated through a series of shell scripts based [the scripts to rule them all](https://github.com/github/scripts-to-rule-them-all)!
+
+To build the materials do the following:
+
+1. Run `script/bootstrap` to install the dependencies
+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