shift3 / devops-apprenticeship-notes Goto Github PK

Is your feature request related to a problem? Please describe.

A good CODEOWNER file can reduce the amount of time we spend auto-adding team members to pull requests and allow more ownership of code to the specified team.

Describe the solution you'd like.

I would like a CODEOWNER file to be added to this repo. I would like it to contain my GitHub username, the team username, and I wold like it to look like: https://github.com/Shift3/terraform-modules/blob/develop/.github/CODEOWNERS but replace Michael Wallerts GitHub username with mine, and the team should be @Shift3/devops-apprentices.

Describe alternatives you've considered

No response

Additional context

For more info on CODEOWNERS: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

Is your feature request related to a problem? Please describe.

The apprentices only have a couple of places to store documentation regarding their apprenticeship. They also have limited experience within GitHub, our preferred change management system.

Describe the solution you'd like.

Apprentices should be able to contribute to their own repo (such as this one).
The repo should contain our S&P standards and include our Issue/PR request templates.
They should be trained on how to use the repo and add any scripts, documentation, or specific topic they did some research in to the repo.

Describe alternatives you've considered

None, I think this GitHub repo is a good place to start.

Additional context

Links that have helped:

• GitHubs own docs: https://docs.github.com/en/get-started/quickstart/contributing-to-projects
• S&P Gitflow docs: https://github.com/Shift3/standards-and-practices#git

Is your feature request related to a problem? Please describe.

We dont have any terraform video resources available for apprentices to take a look at.

Describe the solution you'd like.

We should add more terraform resources to our repo.

Please add a link with a description to the main README.md file.

Example:

• How to contribute to projects: https://docs.github.com/en/get-started/quickstart/contributing-to-projects

Describe alternatives you've considered

No response

Additional context

This is both a sample and useful example regarding adding issues to the Github repo, contributing to a repo, and creating a Pull Request from a forked resource.

Is your feature request related to a problem? Please describe.

Our README only has information on how to contribute. We need more links and resources that help with:

1. AWS
2. Terraform
3. Command line
4. Workshops (any and all that have helped you)
5. Links to our prior "On support" recordings

Describe the solution you'd like.

Please add a link with a description to the main README.md file.

Example:

• How to contribute to projects: https://docs.github.com/en/get-started/quickstart/contributing-to-projects

Describe alternatives you've considered

No response

Additional context

To make changes to this repo is as follows:

1. Fork this GitHub repository into your own Github Account.
2. Checkout the development branch. git checkout development.
3. clone the repository via git clone your-repo-url <--- replace with your github fork url
4. git checkout -b <initials>-<issue number>-<small-description> for example: git checkout -b mac-5-youtube-workshops
5. Open up Visual Studio Code (or other file editor) and navigate to the repo folder.
6. Open the README.md file and make your changes. Example: #5
7. Git add your changes: git add -A README.md (or git add . to add every change).
8. Git commit your changes: git commit -m "feat(README): add useful links"
9. Push your changes to your fork. git push -u origin <branch>
10. Go to your fork and create a Pull Request to this repo.
11. TODO add docs here and pictures
12. Git Pull Request approved.
13. Click merge.
14. Your done! Feel free to create your own GitHub issues, Pull requests, and more. This is your repo, do with it what you want!