Development Workflow

Developing

When developing software for CSnap or the CSDT Community Site, you should follow this process:

1. Update your fork/create a fork of the CSnap-Modules repository
2. Identify the issue you are fixing in the bug tracker; take ownership of it
3. Setup the development environment
4. Make a branch for this particular fix
5. Fix it.
6. Make a pull request

The commands for that flow are:

# if the branch doesn't exist git clone https://github.com/CSnap/CSnap-Modules/
cd {{ Directory of this repo }} # Go to repository
git pull # Update repository
git checkout -b {{name of changes to be made}} # Make a branch
# Make changes & test out changes
git add -A # Adds all changes to commit
git commit # Add a description to your changes
git push origin {{name of changes}} # Push changes to github
# Make pull request on github and reference your issue with #{{issue number}}
git checkout master

Testing

You should test your changes before making a pull request. The easiest way to test is to import the .zip folder you are working on into CSnap, and play around with it. However, you may also wish test the site as it will be by following the setup instructions here, then copying this repo into ./static/applications/csnap-modules.

Pull Requests

All pull requests need to be reviewed by someone else unless they can be flagged as urgent due to downtime on the live site. Do not approve your own pull request without a good reason!

Doing a code review

Verify that the code builds and passes all tests pass. Make sure that all added code is commented as needed, and related to an issue.