new-volunteer-intro

Welcome to Code With Aloha!

This is a repository for getting familiar with contributing and the group!

Prerequisites

1. Install git https://git-scm.com/install/

Contribution instructions

1. Clone this repo locally
2. Make a new branch
3. In Contributors.md, add your github username
4. Push your branch to GitHub
5. Make a pull request
6. Assign it to an organizer for review

• Note: I'm leaving these vague because when you're developing software you'll need to learn how to look up what you need to do either through googling or AI agents.

Troubleshooting

• If you get the following error, you may need to add your SSH key to GitHub. See the instructions here https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent

git@github.com: Permission denied (publickey).
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

• If you get stuck, please reach out in our slack for help.
• If it's an issue you believe more people will hit, create a GitHub issue and we will add it to the troubleshooting section

References

• git clone: https://git-scm.com/docs/git-clone
• git branches:
  • https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell
  • https://git-scm.com/docs/git-switch
  • https://stackoverflow.com/questions/57265785/whats-the-difference-between-git-switch-and-git-checkout-branch
  • Note: git checkout and git switch are both ways of switching between branches, it's best practice to use git switch
• git add: https://git-scm.com/docs/git-add
• git commit: https://git-scm.com/docs/git-commit
• git push: https://git-scm.com/docs/git-push
• Making a Pull Request in GitHub: https://docs.github.com/en/pull-requests/how-tos/create-pull-requests/creating-a-pull-request
• helpful git tutorials:
  • https://www.w3schools.com/git/
  • https://git-explained.pages.dev/