CONTRIBUTING.md

Contributing

First of all, thanks for contributing!

This document provides some basic guidelines for contributing to this repository. To propose improvements, feel free to submit a PR.

Submitting issues

• If you think you've found an issue, please search the Troubleshooting section of our Knowledge base to see if it's known.
• If you can't find anything useful, please contact our support and send them your logs.
• Finally, you can open a Github issue.

Pull Requests

Have you fixed a bug or written a new check and want to share it? Many thanks!

In order to ease/speed up our review, here are some items you can check/improve when submitting your PR:

• Have a proper commit history (we advise you to rebase if needed).
• Write tests for the code you wrote.
• Make sure that all tests pass locally.
• Summarize your PR with a meaningful title, see later on this doc.
• Add the most suitable changelog label choosing one of the following:
  • changelog/Added for new features.
  • changelog/Changed for changes in existing functionality.
  • changelog/Deprecated for soon-to-be removed features.
  • changelog/Removed for now removed features.
  • changelog/Fixed for any bug fixes.
  • changelog/Security in case of vulnerabilities.
  • changelog/no-changelog in case this PR should not appear in the changelog at all.

See here for more details about changelogs.

Your pull request must pass all CI tests before we will merge it. If you're seeing an error and don't think it's your fault, it may not be! Join us on Slack or send us an email, and together we'll get it sorted out.

Keep it small, focused

Avoid changing too many things at once. For instance if you're fixing two different checks at once, it makes reviewing harder and the time-to-release longer.

Pull Request title

Unless the PR is marked with the proper exclusion label, the title will be used to automatically fill the changelog entries. For this reason the title must be concise but explanatory.

Commit Messages

Please don't be this person: git commit -m "Fixed stuff". Take a moment to write meaningful commit messages.

The commit message should describe the reason for the change and give extra details that will allow someone later on to understand in 5 seconds the thing you've been working on for a day.

If your commit is only shipping documentation changes or example files, and is a complete no-op for the test suite, please prepend the commit message with the string [skip ci] to skip the build and test and give that slot to someone else who does need it.

Squash your commits

Please rebase your changes on master and squash your commits whenever possible, it keeps history cleaner and it's easier to revert things. It also makes developers happier!

Integrations Extras

For new integrations, please open a pull request in the integrations-extras repo.