Skip to content

Latest commit

 

History

History
63 lines (44 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

63 lines (44 loc) · 2.47 KB
Raw

Contributing

We appreciate all kinds of contributions. As a contributor, here are the guidelines we would like you to follow:

Found an Issue?

If you find a mistake or unclear formulation in the documentation (sources @ /docs folder), you can help us by submitting an issue to our [GitHub Repository][github]. Including an improvement suggestion helps the team understand the desired change.

You can help the team even more and submit a Pull Request with a concrete improvement or bugfix.

Submitting an Issue

If your issue appears to be a bug, and hasn't been reported, open a new issue. Providing the following information will increase the chances of your issue being dealt with quickly:

  • Motivation for change or Use Case - explain what are you trying to do and why the current state does not fit your needs
  • Related Issues - has a similar issue been reported before?
  • Suggest a Fix - if you can't fix the bug yourself, perhaps you can point to what might be wrong.

You can file new issues by providing the above information here.

Submitting a Pull Request (PR)

Before you submit your Pull Request (PR) consider the following guidelines:

  • Make your changes in a new git branch:

    git checkout -b my-fix-branch master

  • Write the changes in english and check the documents against an english spell-checker (e.g. grammarly)

  • Commit your changes using a descriptive commit message that follows our commit message conventions.

    git commit -a

    Note: the optional commit -a command line option will automatically "add" and "rm" edited files.

  • Push your branch to GitHub:

    git push my-fork my-fix-branch

  • In GitHub, send a pull request to api-principles:master.

Commit Message Guidelines

This project uses Conventional Commits to generate the changelog.

Commit Message Format

docs: <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.