Refer to the following articles on the basics of Git and Github:
- Getting started with Open Source
- Getting started with Git and GitHub
- Forking a Repo
- Creating a issue
- Cloning a Repo
- How to create a Pull Request
- Take a look at the Existing Issues or Create your own Issues!
- Participants have to ask the mentor ro assign the particular issue.
- Wait for the Issue to be assigned to you after which you can start working on it.
- Fork the Repo and Create a Branch for aIssue that assigned you.
- Read the Code of Conduct
- Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.
1. Fork this repository.
Click on the symbol at the top right corner.
2. Clone the repository. Open terminal and type:
git clone https://github.com/<your-github-username>/Woodog
3. Navigate to the project directory.
cd Woodog
4. Add the original repo as the upstream.
git remote add upstream https://github.com/Feminine-Divine/Woodog.git
5. Before creating the branch make sure the master branch of forked repo is even with the master branch of original repo.
# Pull code from original repo
git pull upstream master
# Update the forked repo
git push origin master
6. Create a new branch.
git checkout -b <your_branch_name>
7. Make changes in source code.
8. Make current branch even with the master branch
git pull origin master
9. Resolve all the conflicts
10. Stage your changes and commit
# Add changes to Index
git add .
# Commit to the local repo
git commit -m "<your_commit_message>"
11. Push your local commits to the remote repo.
git push origin <your_branch_name>
12. Create a PR !
13. Congratulations! Sit and Relax, you've made your contribution to Woodog project.
For major changes, you are welcomed to open an issue and discuss about what you would like to contribute. Enhancements will be appreciated.