Skip to content
This repository has been archived by the owner on Feb 3, 2023. It is now read-only.

Latest commit

 

History

History
39 lines (28 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 1.36 KB

Contributing to Liquigraph

Issues & pull requests

We are always eager to accept issues and Pull Requests (PR). Help us help you! When describing an issue, please include as much information as you can, such as:

  • Which versions and flavour (CLI, Maven...) of Liquigraph are you using?
  • Which language (and which version of that language) are you developing with?
  • What operating system are you on?
  • Are you working with a cluster or on a single machine?
  • What code are you running?
  • What errors are you seeing?
  • What solutions have you tried already?

Commit messages

Please try your best to follow these practices:

  1. If it references an issue, start your message with [#ISSUE-NUMBER]
  2. Separate subject from body with a blank line
  3. Limit the subject line to 50 characters
  4. Capitalize the subject line
  5. Do not end the subject line with a period
  6. Use the imperative mood in the subject line
  7. Wrap the body at 72 characters
  8. Use the body to explain what and why vs. how

If you're still lost, please check How to Write a Git Commit Message for a start.

The project history of commits should give a good idea as well.

Coding style

In order to keep a consistent coding style, an .editorconfig is included with the source code. The current configuration keeps the current practices followed by the team.