Thanks for your interest in contributing to the NCTS Syndication Client.
You can find out a bit more about the NCTS Syndication Client by reading the README file within this repository.
The NCTS Syndication Client makes it easier to integrate with the NCTS Syndication API. You can read more about the NCTS Syndication API in the NCTS specifications.
Issues can be used to:
- Report a defect
- Request a new feature or enhancement
- Ask a question
New issues will be automatically populated with a template that highlights the information that needs to be submitted with an issue that describes a defect. If the issue is not related to a defect, please just delete the template and replace it with a detailed description of the problem you are trying to solve.
New pull requests within the NCTS Syndication Client repository are pre-populated with a checklist that describes the Definition of Done that we assess all new changes against. It is ok to submit a pull request that has not yet addressed all of these items, but be aware that the change will not be merged until it meets the Definition of Done.
Please communicate with us (preferably through creation of an issue) before embarking on any significant work within a pull request. This will prevent situations where people are working at cross-purposes.
NCTS Syndication Client uses Sonarcloud to maintain code quality and test coverage standards within the repository.
Pull requests will be automatically run through Sonarcloud, which will report on whether the change has met the configured minimum quality levels.
NCTS Syndication Client has a suite of test cases, located within the src/test
folders of the respective modules within the repository.
Tests are run automatically within CircleCI, and are also run by default within the Maven build. Commits should not be pushed to the main repository with failing tests.
Changes made to the NCTS Syndication Client repository should be accompanied by the appropriate additions or updates to the test suite, to maintain or improve coverage of the code base.
Before making a contribution, please read the code of conduct.