Skip to content

Workflow for polsalt

Steve Crawford edited this page Dec 21, 2015 · 1 revision

How to make a contribution

After [installing the developers version](Installation of polsalt) of polsalt, you can make your own contribution to the main repository by using the following steps:

  1. Create and checkout a new branch

    git branch new_feature
    git checkout new_feature
    

   or the following shortcut:

git checkout -b new_feature



   where new_feature is the name of the branch you want to add.

2.  Update the file that you are interested in.

3.  Once you have updated them, add and commit them to your current repository.
    ```
    git add new_feature.py
    git commit 
    ```
    The command `git commit` will open up an editor for you to add a short message about the changes you have added.

4. Push your changes to your repository on github

git push origin new_feature


5.  On github, there will now be a request to 'compare and create pull request' of your recent branch. Create the new pull request to the branch. 

6.  The new pull request will be created, and merged unless there are any comments on it.  Repeat the process from #2 in order to add updates to this pull request.