3.6 KiB
Working With GitHub
GitHub allows you to make changes to a project using git, and later submit them in a "pull request" so they can be reviewed and discussed. Many online how-tos exist so you can learn git, here's a good one.
In order to use GitHub, you need to sign up and set up git. You will also need to click the Fork button on the dash.org GitHub page and clone your GitHub repository into a local directory with the following command lines:
git clone (url provided by GitHub on your fork's page) dash.org
cd dash.org
git remote add upstream https://github.com/dash-docs/dash-docs.git
How to send a pull request
- Checkout to your master branch.
git checkout master - Create a new branch from the master branch.
git checkout -b (any name) - Edit files and preview the result.
- Track changes in files.
git add -A - Commit your changes.
git commit -m '(short description for your change)' - Push your branch on your GitHub repository.
git push origin (name of your branch) - Click on your branch on GitHub and click the Compare / pull request button to send a pull request.
When submitting a pull request, please take required time to discuss your changes and adapt your work. It is generally a good practice to split unrelated changes into separate branches and pull requests.
How to make additional changes in a pull request
You simply need to push additional commits on the appropriate branch of your GitHub repository. That's basically the same steps as above, except you don't need to re-create the branch and the pull request.
How to reset and update your master branch with latest upstream changes
- Fetch upstream changes.
git fetch upstream - Checkout to your master branch.
git checkout master - Replace your master branch by the upstream master branch.
git reset --hard upstream/master - Replace your master branch on GitHub.
git push origin master -f
Advanced GitHub Workflow
If you continue to contribute to Dash.org beyond a single pull request, you may want to use a more advanced GitHub workflow.