How to contribute

The page outlines how to contribute in terms of code. If you'd like to report a bug or request a feature, see Features Enhancements & Bug Reports

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. If you wish to contribute in general, rather than in dealing with a specific issue you can ask on the OpenWayback developers mailing list what issues would be best suited for you.

If you wish to work on an issue which may heavily impact the codebase you would be well advised to discuss the matter on the mailing list before hand.

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 within the branch. 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. Style guide.

Please also edit /src/site/markdown/release_notes.md in your branch and add the issue you are resolving to the next expected release.

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.

Pull requests are reviewed by the core commiters of the project. As noted earlier, any work that significantly affects the codebase should be discussed in advance on the mailing list to improve the chances of it being included in the core project.

Acknowledgements

Members (developers and others with direct commit privileges) and contributors are recorded in the relevant fields of the projects POM and displayed on the Maven site's "Project team" page. If you wish to be included, update the relevant section as per the following and include it in your pull request or as a separate pull request.

For members (developers section of POM) the following fields should be used:

• name
• url - should point at Github account (e.g. https://github.com/kris-sigur). The heading for this has been changed from "URL" to "Github Profile"
• organization - The English form of your organizations name. In case of contractors, please use the organizations that is paying for your work.
• organizationUrl - Please use this for the homepage of the organization referenced above.
• Roles/role - May be omitted. Will likely evolve a bit over time

Other fields should not be used. It's just clutter on the page.

For contributors, it is sufficient to post your name (although you are welcome to provide additional data as per the members)