Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (21 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

29 lines (21 loc) · 1.74 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Please note we have a code of conduct, please follow it in all your interactions with the project.

Issues and feature requests

You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by submitting an issue on GitHub. Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed!

Please try to create bug reports that are:

  • Reproducible. Include steps to reproduce the problem.
  • Specific. Include as much detail as possible: which version, what environment, etc.
  • Unique. Do not duplicate existing opened issues.
  • Scoped to a Single Bug. One bug per report.

Even better: Submit a pull request with a fix or new feature!

Creating your contribution

  • Create an issue on GitHub of what you will fix/add
  • Fork the repository on GitHub
  • Create a new branch from dev with the name GH-id123-description, where id123 is the id of your issue and description a little description of your issue.
  • Make your update to the code with commits with meaningful messages.
  • For backend and frontend pull requests, apply the code formatter
    • For the backend, run mvn formatter:format, you can check the format with mvn formatter:validate.
    • For the frontend, run npm run format, you can check the format with npm run validate.
  • Squash your commits if necessary
  • Create a pull request to the dev branch