-
Notifications
You must be signed in to change notification settings - Fork 24
Contributing
Thank you for expressing an interest in helping us create Morf. It's greatly appreciated. Please have a read below.
Please check to see if it's already been reported. If not, feel free to raise a new issue.
Pull requests are extremely welcome. Please read on if you are interested in contributing directly to the code.
Before submitting, please:
- Ensure you have read, signed and submitted the Contributor Agreement.
- Ensure you have read the coding standards.
- Make sure you understand the process detailed below.
Generally speaking, we try to keep PRs as small and tightly scoped as possible, making reviewing and merging clear. If the point of the change is to clean up some code, it's often clearer for that change to be a separate PR.
Bug fixes, documentation improvements etc are extremely welcome and will usually be approved as long as they pass our coding standards.
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.
All submissions will be subject to the following review process, where each step is iterative:
- Must pass the Travis build
- Sonar metrics should be acceptable.
- A maintainer will perform a code review on the pull request to ensure coding standards, quality of testing etc.
- 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!
- On success, the pull request will be merged.
© 2017-2018 Alfa Financial Software