How to contribute

The process

There are four basic steps - outlined below - that anyone can follow; Issue, Branch, Code, Pull-Request. This document assumes you know how to check the code out of GitHub and get it running in a development environment. TODO: Developers instructions.

Issue

All contributions should have an issue associated with them in the OpenWayback issue tracker on GitHub. If there is no issue for the bug/feature you wish to address, please raise one.

Branch

Please create a branch of the existing code base in your own GitHub repo. This branch should be based on, as up-to-date as possible master branch of the project. This branch should only be used to address one specific issue (or a small number of interrelated issues).

Code

Make any changes that are necessary. Avoid making unnecessary changes such as reformatting code or otherwise touching parts of the codebase that are not directly relevant to the issue at hand. Please include appropriate JavaDoc documentation. Do follow the code style of the project. TODO: Style guide.

Pull-Request

Once your changes are, in your opinion, ready for inclusion in the project, please raise pull-request. You can explain your choices in how this issue was addressed in the issue tracker, as part of the pull-request and/or via the OpenWayback developers mailing list.