CONTRIBUTING.md

Contributing

Help us make this project better by contributing. Whether it is a new feature, a bug fix, or simply improving the documentation, your contribution is welcome. Please start by logging a github issue or by submitting a pull request.

To help ensure a smooth process for everyone, please read our code of conduct and review the following guidelines before contributing.

Issue reporting

• Please browse the existing issues before logging a new issue.
• Check that the issue has not already been fixed in the main branch.
• Open an issue with a descriptive title and a summary.
• Please be as clear and explicit as you can in your description of the problem.
• Please state the affected versions in the description.
• Include any relevant code in the issue summary.

Pull requests

• Read how to properly contribute to open source projects on Github.
• Fork the project.
• Use a feature branch.
• Write good commit messages.
• Use the same coding conventions as the rest of the project.
  • Import these eclipse preferences with Workspace Mechanic to handle this automatically in the eclipse IDE.
• Commit locally and push to your fork until you are happy with your contribution.
• Make sure to add tests and verify all the tests are passing when merging upstream.
• Add an appropriate entry to the Changelog.
• Please add your name to the CONTRIBUTORS.md file. Adding your name to the CONTRIBUTORS.md file signifies agreement to all rights and reservations provided by the License.
• Squash related commits together.
• Open a pull request.
• The pull request will be reviewed by the community and merged by the project committers.

Integration Tests

• An HNAM domain is required for integration testing.
• The integration tests for the CCL and Whitenoise pluigns require a profile providing the domain-specific settings and a system property named maven-profile with its value equal to the id of that profile. The Whitenoise plugin further requires that profile to be activated by that system property. It is convenient to have the profile set the system property. See ccl-maven-plugin and whitenoise-maven-plugin for details.