You want to contribute to the JPA Processor? Welcome! Please read this document to understand what you can do:
For bugs, questions and ideas for enhancement please open an issue here on GitHub.
In case you need to report a bug, please provide the following information:
- The JPA Processor version you use.
- The JPA implementation you use. EclipseLink, Hibernate, Open JPA or ...
- The version of the JPA implementation.
- A description of the model or a part of the model used when the problem occurred e.g. by providing an snippet of the $matadata document.
- A description of the problem including the request, that create it.
You are welcome to contribute code to the JPA Processor in order to fix bugs or to propose enhancements.
There are four important things to know:
- You have to follow SAPs contribution guidelines as well as SAPs AI-generated code contributions guidelines.
- You must be aware of the Apache License (which describes contributions) and agree to the Developer Certificate of Origin, see the contribution guidelines. This is common practice in all major Open Source projects. To make this process as simple as possible, we are using CLA assistant. CLA assistant is an open source tool that integrates with GitHub very well and enables a one-click-experience for accepting the DCO. See the respective section below for details.
- There are some requirements regarding code style and quality which need to be met (we also have to follow them). The respective section below gives more details on the coding guidelines.
- Not all proposed contributions can be accepted. The code must fit the overall direction of the JPAProcessor and really improve it. For most bug fixes this is a given, but it could haven that design ideas get violated.
Code that is contributed should use:
A contribution should contain tests when ever possible. An approved pull request must not be changed after the approval.