ArcLight is a collaborative open source project where contributions are welcome. This contributing guide is borrowed in part from the GeoBlacklight Contributing Guide.
Did you find a bug in ArcLight or interested in a new feature? Please make sure to add an issue for it in the issue tracker as follows:
- Make sure you have a GitHub account
- Submit a new Github issue by:
- Clearly describing the issue
- Provide a descriptive summary
- Explain the expected behavior
- Explain the actual behavior
- Provide steps to reproduce the actual behavior
ArcLight also welcomes code and documentation contributions. We follow the pull request model for contributing on GitHub.
- Fork it ( http://github.com/sul-dlss/arclight/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
Here are some general rules to follow for merging pull requests.
- It is considered "poor form" to merge your own request.
- Please take the time to review the changes and get a sense of what is being changed. Things to consider:
- Does the commit message explain what is going on?
- Does the code changes have tests? Not all changes need new tests, some changes are refactorings
- Do all new methods, modules, and classes have comments? Do changed methods, modules, and classes have comments?
- Does the commit contain more than it should? Are two separate concerns being addressed in one commit?
- Did the Travis tests complete successfully?
- If you are uncertain, bring other contributors into the conversation by creating a comment that includes their
@username. - If you like the pull request, but want others to chime in, create a +1 comment and tag a user.
If you wish to ask questions or participate further, see our general README.