How to contribute to SAIL

If you want to contribute to SAIL, submit a bug, feature requests, please follow the guidelines below.

Create fork and make changes

• Create a personal fork of SAIL on your Github.
• Clone the personal fork on your local machine to which you'll then be allowed to push changes.

git clone https://github.com/<USER_NAME>/sail.git
cd sail

• Your remote repo on Github is called origin. Check using the below command.

git status

• Add the original SAIL repository as a remote called upstream.

git remote add upstream https://github.com/IBM/sail.git

• Post about your intended feature/bug in an issue
• Create a new branch from main to work on!
• Implement your changes, comment your code and write unit tests.
• Follow the code style of the project. Recommended: Use black as formatter and Pylint for linting.
• If the project has tests, run them. Write or adapt tests as needed.

Update your fork with the upstream

• If you created your fork a while ago be sure to pull upstream changes into your local repository regularly.
• Fetch latest changes from upstream

git fetch upstream

• Merge upstream changes to your local branch

git checkout origin/<LOCAL_BRANCH>
git merge upstream/main

• Optinally, merge upstream changes to your master branch so that you can create a new branch from it later.

git checkout origin/main
git merge upstream/main

Push your code and create pull request.

• Push your branch changes to your fork on Github, the remote origin.
• From your fork open a pull request in the main branch assign it to seshutir or dhavalsalwala.
• Link your pull request with the corresponding issue.
• Once the pull request is approved and merged, you can pull the changes from upstream to your local repos.