In this repo, we explain how to get started with Open Source contributions and be a part of the Software Underground!
For more in depth documentation, here are some git and github tutorials:
Let's put a version control demo into action!:
fork this repository
(insert pic pointing to fork, say username should look like name/getting-started)clone your fork to local machine
- Option 1: From terminal with git installed:
git clone https://github.com/softwareunderground/getting-started - Option 2: From code editor such as Visual Studio Code
(insert pic pointing to clone or download, if you have a code editing software copy https and clone in code editor's environment)
edit this README document, sign your name at the bottom!
(pic of where to click for edit and where to put your name)commit the change to your fork
- Option 1: From a git-aware terminal:
- Checkout a new branch where you can track your changes
checkout -b <my-branch-name> - Add the file you want to track
git add README.md - Commit your changes to the page. Include a useful commit message. First line is title (<54 chars), rest is body (<79 chars / line)
EDITOR=nano git commit - Push your changes upstream
git push --set-upstream origin <my-branch-name>
- Checkout a new branch where you can track your changes
- Option 2: From a code editor:
(to be added)
- Option 1: From a git-aware terminal:
submit your pull request through the github website (pic of where to click for each of these)
You're done!
If you want, drop a line to the community--we're here to encourage! Software Underground Community Link
Add your name here, and check out after, you are now part of the contributors.
Chance Sanger | Jesper Dramsch | Will Sanger