We are quite glad you made it here! We can only keep our project in good health thanks to contributors like you! There are some points we would like to highlight in terms of contributing to this repository.
-
If you have any issue please report that using Github Issues. Currently there's two kinds; Bug Reports and New Features.
-
When writing a Bug Report or asking for a New Feature, please follow the template provided. Fill in the sections as much as you could so we have all the information we need.
-
All coding contributions should be done through pull requests. We do not respond to emails or coding posted via our Gitter channel. If you have any suggessions or want to contribute please open a issue first. This way we could discuss about the change and once finalized you could do a pull request.
-
We don't have a comprehensive style guide for now, but we expect you code with due deligence with standard practices. Your code should pass the standard unit and integration tests (automatically run by Travis).
-
Also please make sure your tests pass the Sonar quality analysis. We strive to maintain A grade for all sections.
-
All code should ideally be accompanied with unit tests. JUnit and Jest is used for backend and front-end unit testing. Please refer to the standard JHipster documentation on testing.
⛄ This is all for now. Hope to update this document as we go along. If you have any suggestions please feel free to open an issue in our issue tracker. ⛄