Skip to content

Contributing.md

Latest commit

聽

History

History
45 lines (31 loc) 路 1.91 KB

Contributing.md

File metadata and controls

45 lines (31 loc) 路 1.91 KB
Raw

Contributing to Dynamic Relations

We encourage and appreciate feedback and contribution from the community!

Question or Problem?

Feel free to open an Issue with an Question or Bug Report.

Issue and Feature Requests

Search Github Issues for existing bugs report or features request related to your question. Please submit an Issue or Feature Request if your issues or requests have not been listed.

PR Submission Guidelines

  • Search Github Pull Requests for PRs related to your submission. Make sure that this is not a duplication.
  • Link the issue addressed by the PR.
  • Add unit tests or document manual tests to validate the changes.
  • Workflow shall triggers all unit tests. For a pull request to be accepted, all unit tests must be green.

Coding Rules

Please follow the rules as you work on the code:

  • Please add unit tests for each fixed bug or added feature.
  • Please use clean and informative names.
  • Leave the code better than you find it.
  • Use the given Style Guide Style Guide

Set Up

When starting out, make sure to check these few things before building the project:

  • Ensure that Annotation Processor is enabled in your IDE.
  • Ensure that the processor FQ name is added and set to: at.drm.processor.RelationProcessor.
  • For IntelliJ, ensure you use the inbuilt Build tool found at the 'Build' tab. Running mvn clean install in the CLI will NOT have Annotation Processors activated which is required for this project.

Happy contributing 馃槂