This repository will help beginners who have just completed the Git course & want to apply their theoretical knowledge.
Geeks who are eager to contribute, must read it.
- Make sure you have a GitHub account.
- Search GitHub and Google to see if your issue has already been reported
- Create an issue in GitHub, assuming one does not already exist.
- Clearly describe the issue including steps to reproduce when it is a bug.
- Make sure you fill in the earliest version that you know has the issue.
- Goto the Simple-Static-Website repository
- Click on the Fork button in the upper right corner.
Introduce your self to GIT, make sure you use an email associated with your GitHub account.
git config --global user.name "John Doe"
git config --global user.email johndoe@example.com
Make sure you clone the forked repository.
git clone https://github.com/<your username>/simple-static-website.git
Switch Simple-Static-Website to your fork
git remote set-url origin https://github.com/<your username>/simple-static-website.git
Setup simple-static-website to be able to fetch from the master
git remote add upstream https://github.com/The-Codesis/simple-static-website.git
When you add a new feature always create an issue first, this allows others to comment and give you tips. It will also help us keep track of what people are adding and with new releases helps us to write new release notes and give you credit for your work.
Secondly, always work in a branch, never work on the master branch. Keep your master branch in sync with the master of the official Simple-Static-Website repository. This makes the pull requests (you do want your work to be in the main branch right?) easier for us.
Finally, try to keep your branches focused on fixing/adding only one feature and try not to fall in the trap of doing a lot of things in a single branch. This will not only make it harder for us to process your pull request but makes it take longer before you can submit your pull request. Small pull requests are more likely to be looked at faster and pulled into the main branch faster.
Here is a simplified workflow on how to add a new feature:
Update your master (both locally and on GitHub)
git fetch upstream
git checkout master
git merge upstream/master
git push
A good practice is to call the branch in the form of GH- followed by the title of the issue. This makes it easier to find out the issue you are trying to solve and helps us to understand what is done in the branch. Calling a branch my-work is confusing. Names of a branch can not have a space, and should be replaced with a hyphen.
git checkout -b GH-issuenumber-title-of-issue
Do you work, and commit as you see fit. Make your commit messages helpful.
If this is the first time pushing to GitHub you will need to extended command, otherwise, you can simply do a git push.
git push -u origin GH-issuenumber-title-of-issue
When finished create a pull request from your branch to the main Simple-Static-Website repository.