-
Notifications
You must be signed in to change notification settings - Fork 4
Home
- You can contribute in terms of Code
- You can contribute in terms of improving Documentation
Look in the issues if the change you are doing is available and issues section is it assigned to someone or not if you can't find any issue open one. Anyone from our team will assign you the issue then you can start contributing
You can fork this repository by clicking on fork button on top right corner. Once you fork this will create a copy of repo on your account.
To clone the repository go to your account open this repo and either click on clone button or run the command below to get this repository on your local machine.
git clone "URL you just copied" e.g. git clone https://github.com/mlsasrmncr/mlsasrmncr-Website/
Configure remotes: (Important)
git remote add upstream https://github.com/mlsasrmncr/mlsasrmncr-Website
On your local machine go the project folder that you cloned and use following git command inside that folder
Create a new branch using below command.
git checkout -b <branch-name> e.g.
git checkout -b mybranch
Make changes to files on your local machine work on the issue you're assigned.
Now we have to add changes that we made to the branch so for that we will run following command.
git add .
Now we have to commit changes, commit message should always be clear, to commit use command below
NOTE:- Always add the issue number in your commit for easiness and also mention the issue no (eg. #345) in the description of the pull request. And always push something under a issue only.
git commit -m "resolved the <issue>"
Now we have to push the changes that we made to remote repository on specified branch to do so use command below.
git push origin <branch-name> name of branch is same as you created in step 3
e.g git push origin mybranch
All additional commits, please squash to first
e.g:
git rebase -i main
git push --force origin <branch name>
Step 9 Update current branch and local master by pulling changes that were done by other contributors:
e.g:
git checkout main
git pull upstream main
git push origin main
e.g:
git checkout <branch name>
git rebase main
In the process of the rebase, it may discover conflicts. In that case it will stop and allow you to fix the conflicts. After fixing conflicts, use git add . to update the index with those contents, and then just run: e.g:
git rebase --continue
e.g:
git push --force origin my-new-check
Once you have pushed your code to GitHub, it's now time to create pull request, you will go to the repository click on compare and pull request, don't forget to add the issue number in the pull request description and submit the pull request.
Good example of pull request: PR#6
Soon, we will be merging all your pull requests to the main branch of project and you will also get notification once your pull request is merged with existing code base. After that you will be able to see your details in contributor section on the page below.