Skip to content

Latest commit

 

History

History
68 lines (41 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

68 lines (41 loc) · 2.81 KB
Raw

Contributing Guidelines

The following is a set of guidelines for contributing. We really appreciate that you are considering contributing!

Table Of Contents

Ask a Question

Contributing

Development

Style Guides

Code of Conduct

Ask a Question

Please open an Issue on GitHub with the label question.

Contributing

Report a Bug

To report a bug, open an issue on GitHub with the label bug using the available bug report issue template. Please ensure the issue has not already been reported.

Suggest an Enhancement

To suggest an enhancement, please create an issue on GitHub with the label enhancement using the available feature issue template.

Open a Pull Request

  • Fork the repo, create a branch, submit a PR when your changes are tested and ready for review.
  • Fill in our pull request template

Note: if you’d like to implement a new feature, please consider creating a feature request issue first to start a discussion about the feature.

Development Guide

Please see the development guide for how to set up your local environment.

Style Guides

Git Style Guide

  • Keep a clean, concise and meaningful git commit history on your branch, rebasing locally and squashing before submitting a PR
  • Use the Conventional Commits format when writing a commit message, so that changelogs can be automatically generated
  • Follow the guidelines of writing a good commit message as described here and summarised in the next few points
    • In the subject line, use the present tense ("Add feature" not "Added feature")
    • In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...")
    • Limit the subject line to 72 characters or less
    • Reference issues and pull requests liberally after the subject line
    • Add more detailed description in the body of the git message (git commit -a to give you more space and time in your text editor to write a good message instead of git commit -am)

Java Style Guide

  • Java code should conform to the Google Java Style whenever possible.
  • The make target java-checkstyle should pass without errors.
  • Where feasible, include unit tests.

Python Style Guide

  • Python code should conform to the PEP-8 style guidelines whenever possible.
  • Where feasible, include unit tests.