Skip to content

Latest commit

 

History

History
85 lines (58 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

85 lines (58 loc) · 3.21 KB
Raw

Contribution Guidelines

Thank you for your interest in contributing to our project :)
We like issue reports, suggestions and pull request from everyone.

If you are planning to make a major contribution for which there is no existing issue, we would appreciate that you open an issue first.

The following suggestions increase the chance that your pull request can be accepted:

  • Write clean code
  • Write tests for your new code
  • Check that all tests are still passed
  • Adhere to the naming conventions for branch names and commit messages mentioned below
  • Avoid unnecessary breaking changes

You and your code contribution has to adherence to the licence of this project.

Naming Conventions

Branch Names

Branch names should follow the following structure: <type>/<issue-id>/<name>

  • <type> is the type of the change (see table below).
  • <number> is the number of the corresponding issue on GitHub the branch should resolve.
  • <name> is a describing branch name, which should be in lowercase separated by dashes.

Allowed Change Types

Change Type Description
feat Adds a new or expands an existing feature
fix Fixes a bug
docs Updates documentation only
style Code style improvements, no logic changes
refactor Refactorings (neither "feat" nor "fix")
perf Performance optimizations
test Adds or improves test cases
build Build system or external dependency changes
ci Changes to the CI configuration or scripts
chore Other changes, do not modify src or test files
revert Reverts a previous commit

Examples:

  • feat/123/settings-option-xyz
  • fix/124/unexpected-settings-error

Commit Messages

Commit messages should follow the Conventional Commits standard with the following additional rules:

  • The first line MUST end with the id of the corresponding issue on GitHub.
  • The type MUST be one of the types in the table "allowed change types" above.
  • Breaking changes MUST be indicated in the type/scope prefix of a commit by adding an exclamation mark ! before the colon :.

This results in the following structure for commit messages:

<type>[optional scope][!]: <description> #<issue-id>

[optional body]

[optional footer(s)]

Examples for acceptable commit messages:

  • fix: wrong expected result in test case for java #1

  • feat: records are now supported for C# #2

  • feat!: change format of the json output #3

Introduced new field named info that might break code which works with our json output

  • tech: improve handling of errors in GenericParser.ts #4

Pull Requests

Follow the given template when opening the PR

  • Give the PR a meaningful title to describe what it changes. E.g. issue or branch name.
  • Add the correct labels
  • The PR Assignee is only used by the reviewer to see who is reviewing it