Non-technical folks would be best served by opening an issue on the issue pages - please check to see no one else has opened a similar/duplicated issue already.
Bear in mind that this is a standard used by many other resources, so it might not be suitable to add just one minor thing to serve your specific requirements. The schema is also developed using semver so minor and patch additions are far more likely to make their way into the standard than major breaking changes as we aim for stability and compatibility.
If you would like to contribute code changes to the specification please follow these steps:
Fork, then clone the repo:
git clone git@github.com:your-username/phenopacket-schema.gitSet up your machine. This requires Java 1.8 or higher.
Make sure the tests pass:
./mvnw clean packageMake your change. Add tests for your change. Make the tests pass:
./mvnw clean packagePush to your fork and submit a pull request.
Wait for a response. We may suggest some changes or improvements or alternatives.
Some things that will increase the chance that your pull request is accepted:
- Write tests.
- Follow the current style - for protobuf see the protobuf style guide.
- Write a good commit message.