Skip to content

Commit 327b7af

Browse files
BigDawgSwagBigDawgSwag
committed
Merge branch 'main' of https://[email protected]/BigDawgSwag/training-kit.git
2 parents 8cfc31b + 21e6348 commit 327b7af

File tree

104 files changed

+11889
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

104 files changed

+11889
-0
lines changed

‎.github/ISSUE_TEMPLATE.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## Overview
2+
3+
<!-- One to two sentence description of the issue you are encountering or trying to solve. -->
4+
5+
### Extra detail
6+
7+
<!-- Please include any additional details that may be helpful in understanding the issue. -->
8+
#### Screenshots
9+
10+
<!-- If bug fix, please upload images of the error to better showcase the problem. -->
11+
12+
#### Reasoning
13+
14+
<!-- If new idea or direction, please create a checklist of proposed ideas or next steps. [Example](https://github.com/github/training-kit/issues/415). -->
15+
16+
### How to contribute
17+
18+
- Comment on this issue if you'd like to work/collaborate on it!
19+
- Fork the [repository](https://github.com/github/training-kit).
20+
- 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.
21+
- Push your changes to your repository.
22+
- Submit a Pull Request
23+
- Base Dropdown: github/training-kit
24+
- Compare Dropdown: Your fork
25+
26+
#### Testing locally
27+
28+
If you'd like to make and test changes locally (and see how they would look if merged), do the following:
29+
30+
- In your command line:
31+
- [Install Git](https://git-scm.com/)
32+
- [Install Ruby](https://www.ruby-lang.org/en/documentation/installation/)
33+
- [ ] Run `script/setup`
34+
- [ ] Run `script/server`.
35+
- When successful, the script will initiate a local server at `http://127.0.0.1:4000/`.
36+
37+
### Questions?
38+
39+
- Leave a comment on this issue! Make sure to use `@mentions` if you want a specific person's attention!

‎.github/PULL_REQUEST_TEMPLATE.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## Overview
2+
3+
<!--
4+
One to two sentence description of the issue you are encountering or trying to solve.
5+
6+
Link to related issue. Type `closes #RELATED_ISSUE_NUMBER` to establish a link.
7+
-->
8+
9+
## Questions
10+
11+
<!-- If relevant, write a list of questions that you would like to discuss related to the changes that you have made. -->
12+
13+
## Next steps
14+
15+
<!-- If incomplete, create a task list of items that are still being worked on within the Pull Request. -->
16+
17+
## Review
18+
19+
<!-- If complete, or ready for :eyes:, use @mentions for quick questions, specific feedback, and progress updates. -->

‎.github/dependabot.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Please see the documentation for all configuration options:
2+
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
3+
4+
version: 2
5+
updates:
6+
7+
# Maintain dependencies for GitHub Actions
8+
- package-ecosystem: "github-actions"
9+
directory: "/"
10+
schedule:
11+
interval: "monthly"
12+
13+
# Maintain dependencies for Bundler
14+
- package-ecosystem: "bundler"
15+
directory: "/"
16+
schedule:
17+
interval: "monthly"

‎.github/workflows/codeql.yml

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: "CodeQL"
2+
3+
on:
4+
push:
5+
branches: [ "main" ]
6+
pull_request:
7+
# The branches below must be a subset of the branches above
8+
branches: [ "main" ]
9+
10+
jobs:
11+
analyze:
12+
name: Analyze
13+
runs-on: ubuntu-latest
14+
permissions:
15+
actions: read
16+
contents: read
17+
security-events: write
18+
19+
strategy:
20+
fail-fast: false
21+
matrix:
22+
language: [ 'ruby' ]
23+
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
24+
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
25+
26+
steps:
27+
- name: Checkout repository
28+
uses: actions/checkout@v3
29+
30+
# Initializes the CodeQL tools for scanning.
31+
- name: Initialize CodeQL
32+
uses: github/codeql-action/init@v2
33+
with:
34+
languages: ${{ matrix.language }}
35+
# If you wish to specify custom queries, you can do so here or in a config file.
36+
# By default, queries listed here will override any specified in a config file.
37+
# Prefix the list here with "+" to use these queries and those in the config file.
38+
39+
# 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
40+
# queries: security-extended,security-and-quality
41+
42+
43+
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
44+
# If this step fails, then you should remove it and run the build manually (see below)
45+
- name: Autobuild
46+
uses: github/codeql-action/autobuild@v2
47+
48+
# ℹ️ Command-line programs to run using the OS shell.
49+
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
50+
51+
# If the Autobuild fails above, remove it and uncomment the following three lines.
52+
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
53+
54+
# - run: |
55+
# echo "Run, Build Application using script"
56+
# ./location_of_script_within_repo/buildscript.sh
57+
58+
- name: Perform CodeQL Analysis
59+
uses: github/codeql-action/analyze@v2
60+
with:
61+
category: "/language:${{matrix.language}}"

‎.github/workflows/dependency-review.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependency Review Action
2+
#
3+
# 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.
4+
#
5+
# Source repository: https://github.com/actions/dependency-review-action
6+
# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
7+
name: 'Dependency Review'
8+
on: [pull_request]
9+
10+
permissions:
11+
contents: read
12+
13+
jobs:
14+
dependency-review:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: 'Checkout Repository'
18+
uses: actions/checkout@v3
19+
- name: 'Dependency Review'
20+
uses: actions/dependency-review-action@v2

‎.github/workflows/jekyll.yml

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: Deploy Jekyll site to Pages
2+
3+
on:
4+
# Runs on pushes targeting the default branch
5+
push:
6+
branches: ["main"]
7+
# Runs on pull requests targeting the default branch
8+
pull_request:
9+
branches: [ "main" ]
10+
11+
# Allows us to run this workflow manually from the Actions tab
12+
workflow_dispatch:
13+
14+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
15+
permissions:
16+
contents: read
17+
pages: write
18+
id-token: write
19+
20+
# Allow one concurrent deployment
21+
concurrency:
22+
group: "pages"
23+
cancel-in-progress: true
24+
25+
jobs:
26+
# Build job
27+
build:
28+
runs-on: ubuntu-latest
29+
steps:
30+
- name: Checkout
31+
uses: actions/checkout@v3
32+
- name: Set up Node
33+
uses: actions/setup-node@v3
34+
with:
35+
node-version: 16
36+
cache: 'npm'
37+
- name: Install node modules
38+
run: npm install
39+
- name: Set up Ruby
40+
uses: ruby/setup-ruby@ece82769428359c077b5a5eaff268902a303c101
41+
with:
42+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
43+
- name: Set up Pages
44+
id: pages
45+
uses: actions/configure-pages@v2
46+
- name: Build and test with Rake
47+
# Only run in pull requests
48+
if: github.event_name == 'pull_request'
49+
run: bundle exec rake
50+
- name: Build with Jekyll
51+
# Don't run in pull requests
52+
if: github.event_name != 'pull_request'
53+
# Outputs to the './_site' directory by default
54+
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
55+
env:
56+
JEKYLL_ENV: production
57+
- name: Upload artifact
58+
# Automatically uploads an artifact from the './_site' directory by default
59+
uses: actions/upload-pages-artifact@v1
60+
61+
# Deployment job
62+
deploy:
63+
# Only run on pushes to the default branch
64+
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
65+
environment:
66+
name: github-pages
67+
url: ${{ steps.deployment.outputs.page_url }}
68+
runs-on: ubuntu-latest
69+
needs: build
70+
steps:
71+
- name: Deploy to GitHub Pages
72+
id: deployment
73+
uses: actions/deploy-pages@v1

‎.gitignore

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
_site/
2+
.DS_Store
3+
/.rbenv-version
4+
/vendor/
5+
/bin/
6+
/.bundle/
7+
.sass-cache/
8+
*.*~
9+
_release
10+
*.map
11+
.jekyll-metadata
12+
node_modules/
13+
# *.resume-burger-jokes

‎.ruby-version

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.1.2

‎CNAME

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
training.github.com

‎CODE_OF_CONDUCT.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
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.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
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.
28+
29+
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.
30+
31+
## Scope
32+
33+
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.
34+
35+
## Enforcement
36+
37+
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.
38+
39+
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.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

‎CONTRIBUTING.md

+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Contributing to training-kit
2+
3+
🎉 Thank you for taking the time to contribute and for seeking out these instructions. We :heart: community contributions to these materials.
4+
5+
---
6+
7+
## Code of Conduct
8+
9+
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]).
10+
11+
---
12+
13+
## What should I know before I get started?
14+
15+
### The goal of these resources
16+
17+
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:
18+
19+
- Feel welcome and become active contributors in the open source community
20+
- Learn best practices for using Git and GitHub
21+
- Learn how to use the applications within GitHub's ecosystem to build better software
22+
23+
### Types of contributions we love
24+
25+
We're always looking for contributions to help improve these resources. This includes:
26+
27+
- Improving the existing cheat sheets
28+
- Translations of existing cheat sheets into new languages
29+
- Adding new courseware or resources aligned with the [goals](#the-goal-of-these-resources)
30+
31+
---
32+
33+
## How to contribute
34+
35+
### Report a bug
36+
37+
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.
38+
39+
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.
40+
41+
### Translate existing resources
42+
43+
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:
44+
45+
- Fork this repository
46+
- 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.
47+
- 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.
48+
- Complete the translation
49+
- Add a link to the translated resource on [/index.html](https://github.com/github/training-kit/blob/main/index.html)
50+
- Open a pull request against the `main` branch of this repository.
51+
- Be sure to @ mention a couple of your friends who are native speakers and ask them to review the translation.
52+
- Update your translation based on feedback from your friends.
53+
54+
When this process is complete, we will be happy to merge the completed document.
55+
56+
### Contribute something new
57+
58+
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.
59+
60+
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.
61+
62+
### Not sure where to start?
63+
64+
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).
65+
66+
---
67+
68+
### Styling content
69+
70+
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/).
71+
72+
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.
73+
74+
### Building and testing
75+
76+
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)!
77+
78+
To build the materials do the following:
79+
80+
1. Run `script/bootstrap` to install the dependencies
81+
1. Run `script/build` to build the site
82+
1. Run `script/server`
83+
- When successful, the script will initiate a local server at `http://127.0.0.1:4000/`.
84+
1. Simply paste that into your favorite web-browser, and you will be ready to test

0 commit comments

Comments
 (0)