Skip to content

Contributing

Graham Crockford edited this page Nov 22, 2017 · 12 revisions

Thankyou for expressing an interest in helping us create Morf. It's greatly appreciated. Please have a read below.

Bug reports, feature requests

Please check to see if it's already been reported. If not, feel free to raise a new issue.

Pull requests

Before we can accept pull requests, please:

All submissions will be subject to the following review process, where each step is iterative:

  1. Must pass the Travis build
  2. Sonar metrics should be acceptable (currently impossible - see #31
  3. A maintainer will perform a code review on the pull request to ensure coding standards, quality of testing etc.
  4. A maintainer from Alfa will merge the pull request to our integration testing branch and subject it to a suite of closed-source integration tests. These ensure that the changes do not cause regressions in our commercial products. If there are any failures at this stage, this will be treated as a gap in the tests - really nothing should fail at this stage!
  5. On success, the pull request will be merged.

Bug fixes & documentation improvements

Bug fixes, documentation improvements etc are extremely welcome and will usually be approved as long as they pass our coding standards.

New features

No new features will be added without advance design and approval, and no feature pull requests without an associated issue.

  • Please check the roadmap and issues to see if someone else is already working on it.
  • Create a new issue, explaining your idea, so the community can discuss the requirements and approach. Once there is agreement, you will be welcome to submit a pull request with the changes.

A mailing list will be added soon to make discussions easier.

Clone this wiki locally