-
Notifications
You must be signed in to change notification settings - Fork 3
Contributing Code Workflow
The instructions in the following is based upon these resources:
these are python projects but the same concepts apply for IDL.
Working of your own forked version of the repository is the preferred approach. To fork the repository visit the repository page at https://github.com/i4ds/STIX-GSW (make sure you are logged into github) and click on the fork button at the right of the page.
Clone your forked version of the
git clone https://github.com/<username>/STIX-GSW.git
It is also advisable to configure the upstream remote at this point
git remote add upstream https://github.com/i4ds/STIX-GSW
It’s import to always be working from the most recent version of the so before working on any code start by getting the latest changes and then creating a branch for you new code.
git checkout master
git pull upstream master
git checkout -b <branch-name>
Branch names should ideally be short and descriptive e.g. ‘feature-xmlparseing’, ‘bugfix-ql-fits’, ‘docs-devguide’ and preferably separated by dashes ‘-’ rather than underscores ‘_’.
Once you are happy with your changes push the changes to github
git add <list of modified or changed files>
git commit
git push origin <branch-name>
and open a pull request (PR).
Note a series of checks will be automatically run on code once a PR is created it is recommended that you locally test the code as outlined below.