CONTRIBUTING.md

Contributing

• Contributors should fork this repo
• Changes should be made in feature branches in their own repo
• A feature is submitted to this repo via creating a GitHub Pull Request (PR)
• The Pull Request can then be merged by the contributor or another developer with commit access
• PR merging should be done using Squash and Rebase

Git Workflow

Create personal fork, local repo, and remotes

1. Fork on GitHub (for example, into account my-gh)
2. On local machine...
3. cd <proj-dir>
4. git clone [email protected]:my-gh/spatial-suite-demo-webapp.git
5. cd spatial-suite-demo-webapp
6. Add CrunchyData repo as remote upstream using git remote add upstream [email protected]:CrunchyData/spatial-suite-demo-webapp.git
7. Check remotes: git remote -v
8. Synch with upstream: git pull upstream master

Work with a Feature Branch

1. Start on master branch: git checkout master (confirm with git status)
2. Synch with upstream: git pull upstream master
3. Create feature branch: git checkout -b new-feature
4. Make changes
5. Review changes with git status
6. Stage changes: git add -A or git add ...
7. Commit changes: git commit -m 'msg about new feature'
8. Push to fork repo: git push

Create and merge a GitHub PR

1. On GitHub fork, switch to branch and click [Create Pull Request]
2. On GitHub CrunchySpatial, review PR
3. Fix any conflicts (voodoo goes here - more info needed)
4. Merge PR using [Squash and Rebase]
5. Delete the fork feature branch

Clean up local repo

1. Switch to master branch: git checkout master
2. Synch with upstream: git pull upstream master
3. IF all is well, delete feature branch: git branch -D new-feature