- Contribute code. See below for instructions on Submitting a Pull Request.
- Participate in discussion.
- Spread the word. Know someone who could help out? Please share this project with them!
Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
- Fork the project, clone your fork, and configure the remotes:
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/morpheus.git
# Navigate to the newly cloned directory
cd morpheus
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/vesparny/morpheus.git
- Create a new topic branch (off the develop branch) to contain your feature, change, or fix:
git checkout develop
git checkout -b <topic-branch-name>
-
Commit your changes in logical chunks. Please adhere to these git commit message guidelines
-
When you are ready, clean up. Squash together minor commits. Use Git's interactive rebase feature to tidy up your commits before making them public.
git rebase -i
- Rebase the current topic branch onto upstream/develop to get the last changes (needed if it takes you a while to finish your changes).
git fetch upstream
git rebase upstream/develop
You might have to fix merge conflicts. git status will show you the unmerged files. Resolve all the conflicts, then continue the rebase:
git add ... # add resolved files
git rebase --continue
- Check that all tests still pass and push your branch remotely:
git push origin <topic-branch-name>
- Open a Pull Request with a clear title and description.