Contributing Guide
Before contributing to cyberyen.org, please review the Documentation (opens in a new tab) and the Syntax Guide (opens in a new tab).
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. In order to use GitHub, you need to sign up (opens in a new tab) and set up git (opens in a new tab). You will also need to fork (opens in a new tab) the cyberyen.org repository from its GitHub page (opens in a new tab) 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) cyberyen.org
cd cyberyen.org
git remote add upstream https://github.com/cyberyen-org/cyberyen.org.gitHow 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.
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.
**
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 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