This page has some suggestions for working with the Elision repository.

Our general mode of working is to (1) fork the main repository, (2) work on your local branch, and (3) issue a pull request when you are happy with your changes. We recommend you add the master repository as the upstream repository.

git remote add upstream https://[email protected]/elision/elision.git

Replace the blank with your GitHub username. Now before you issue your pull request you should pull from upstream and fix any conflicts.

git pull upstream master

If it has been a while since you forked, you might want to fetch and merge instead of doing the pull. It's up to you. If you don't understand fetch and merge, then read up on git... or just use pull and let it do its magic.

The following guidelines apply to code you wish to contribute.

• Set your editor to use spaces instead of tabs to indent. The unit of indentation is two spaces.
• Comment your code using complete sentences and try to use correct spelling, grammar, and punctuation.
• Assume the reader can read the programming language. Don't just restate what the code is doing, but try to explain why.
• Scaladoc your code unless you are inheriting existing Scaladoc from a superclass or the field / method is private. Even then Scaladoc is appreciated.
• Prefix the names of all private fields and methods with an underscore.
• Observe the package hierarchy.
• Do not include any new third-party libraries or code in the repository without first asking sprowell. This is to assure consistent licensing - some open source licenses are incompatible.

Please, in all commit messages and postings, use complete sentences and capitalization, try to use correct spelling, and attempt to use correct grammar.

If you commit a fix for issue #349, include the text fixes #349 or closes #349 in the commit message. This will close the issue.