How to Use Github
GitHub Overview
GitHub is a collaborative development platform for open-source software projects. It uses Git, a version control system, to track and log changes to the source code, and display that history front and center.
Community Development(Comm-Dev) at MakerDAO uses GitHub for transparent project planning, visible collaboration, and hosting canonical information. It houses all of the teams documentation and projects.
Comm-Dev takes advantage of GitHub's robust graphic user interface (GUI) for Git; opening issues, and managing content files are the bulk of the work. MakerDAO uses a simple Git branching model, where one party manages the master branch and reviews all changes before adding them.
Lost and have no idea how GitHub works?
Check out this short video for a brief intro to GitHub. Feel free to peruse learn git branching for fundamental git concepts.
Below are two clear guides to GitHub by the MakerDAO Community Development team.
Simple One-off Tasks
- Log into the GitHub website.
- Fork the repository you want to work on. For example, you may want to fork the Community Development GitHub repository.
- In your forked repository, go to file or folder you want to change.
- Commit your changes by filling out the form at the bottom of the page.
- Fill out Pull Request (PR) form.
For Ongoing Contributions
Community development's implementation of a git-based CMS is a brand new approach to community generated content. In order to successfully contribute more than simple changes, a one-on-one tutorial is an engaging and fun way to learn about our stack. Feel free to reach out in Community Development Chat, we'll need to get you an invite to edit the repository. There is an in-depth guide and this TL;DR
- Log into GitHub website, download and log into GitHub Desktop, download VScode and log into GitHub in VScode.
- Clone the repository you want to work on to GitHub Desktop and put the files where you want them to live on your computer.
- Create new branch (always work on your own branch; don't go trying to update the Master branch).
- Open the repository in VScode.
- In VScode, edit, add files, and save your changes.
- Stage and Commit your changes. You can do this in VScode or GitHub Desktop. In GitHub Desktop, all you have to do is fill out the form at the bottom left of the screen.
- Push your Commits and then create a Pull Request (PR). You can do this in GitHub Desktop or VScode. Click Pull Request button to be taken to the GitHub website to fill out the Pull Request form.
- Fill out Pull Request form.
Confused? Reach out in Community Development Chat and someone will walk you through it step-by-step.