Contributing to EvalAI is really easy. Just follow these steps to get started.
Step 1: Fork
- Fork the EvalAI repository from the repository.
Step 2: Selecting an issue
- Select a suitable issue that will be easy for you to fix. Moreover, you can also take the issues based on their labels. All the issues are labelled according to its difficulty.
- After selecting an issue, ask the maintainers of the project to assign it to you and they will assign it based on its availability.
- Once it gets assigned, create a branch from your fork’s updated master branch using the following command:
git checkout -b branch_name
- Start working on the issue.
Step 3: Committing Your Changes
- After making the changes, you need to add your files to your local git repository.
- To add your files, use the following commands:
- To add only modified files, use
git add -u
- To add a new file, use
git add file_path_from_local_git_repository
- To add all files, use
git add .
Once you have added your files, you need to commit your changes. Always create a very meaningful commit message related to the changes that you have done. Try to write the commit message in present imperative tense. Also namespace the commit message so that it becomes self-explanatory by just looking at the commit message. For example,
Docs: Add verbose setup docs for ubuntu
Step 4: Creating a Pull Request
- Before creating a Pull Request, you need to first rebase your branch with the upstream master.
- To rebase your branch, use following commands:
git fetch upstream
git rebase upstream/master
- After rebasing, push the changes to your forked repository.
git push origin branch_name
- After pushing the code, create a Pull Request.
- When creating a pull request, be sure to add a comment including these keywords, and also mention any maintainer to reviewing it.
- If you have any doubts, don’t hesitate to ask in the comments. You may also add in any relevant content.
- After the maintainers review your changes, fix the code as suggested. Don’t forget to add, commit, and push your code to the same branch.
Once you have completed the above steps, you have successfully created a Pull Request to EvalAI.