Our project welcomes external contributions.
To contribute code or documentation, please submit a pull request.
Before embarking on an ambitious contribution, please quickly get in touch with us.
Note: We appreciate your effort, and want to avoid a situation where a contribution requires extensive rework (by you or by us), sits in backlog for a long time, or cannot be accepted at all!
If you would like to implement a new feature, please raise an issue before sending a pull request so the feature can be discussed. This is to avoid you wasting your valuable time working on a feature that the project developers are not interested in accepting into the code base.
If you would like to fix a bug, please raise an issue before sending a pull request so it can be tracked.
The project maintainers use GitHub reviews to indicate acceptance. A change requires approval from two of the maintainers of each component affected. Sometimes, reviewers will leave a comment "LGTM" to indicate that the change "looks good to me".
Each source file must include a license header for the Apache Software License 2.0. Using the SPDX format is the simplest approach. e.g.
/*
* (C) Copyright <holder> <year of first update>[, <year of last update>]
*
* SPDX-License-Identifier: Apache-2.0
*/
We have tried to make it as easy as possible to make contributions. This applies to how we handle the legal aspects of contribution. We use the same approach - the Developer's Certificate of Origin 1.1 (DCO) - that the Linux® Kernel community uses to manage code contributions.
We simply ask that when submitting a patch for review, the developer must include a sign-off statement in the commit message.
Here is an example Signed-off-by line, which indicates that the submitter accepts the DCO:
Signed-off-by: John Doe <[email protected]>
You can include this automatically when you commit a change to your local git repository using the following command:
git commit -s
Connect with us through slack or by opening an issue.
See the Getting Started guide.
To ensure a working build, please run the full build from the root of the project before submitting your pull request.
The IBM Quality Measure and Cohort Service is based on contributions from many individuals. Formatting has not been strictly enforced, but we'd like to improve it over time, so please consider the following points as you change the code:
-
Write tests. Pull Requests should include necessary updates to unit tests (src/test/java of the corresponding project).
-
Use comments. Preferably javadoc.
-
Keep the documentation up-to-date. Project documentation exists under the docs directory.
-
Use spaces (not tabs) in java source. We also prefer spaces over tabs in JSON and XML.
-
Use spaces after control flow keywords (they're not function calls!); if/for/while blocks should always have { }
Leave the code better than you found it.
issue-#
issue # - short description
long description