CONTRIBUTING.md

Contributing to the Aiven docs

When contributing, keep the following in mind:

• Small PRs are preferred. For larger PRs, start by submitting a suggestion as a new issue.
• The content of the repo is under the Creative Commons Attribution 4.0 International license.

Signing off commits

Contributions rely on GitHub's commit signoff feature:

Note: If you commit using the CLI, use the git commit --signoff option.

Guidelines

• Style guide: Apply the style guide.

• Hard line breaks: To simplify reviews on GitHub, add a hard line break at 90 characters. If you use VS Code, you should see the ruler.

• Vale: Install Vale and fix warnings and errors in your content.

• Conventional commits: We enforce conventional commits. Examples:

  • fix: incorrect parameter
  • feat: add dark mode
  • add: auto-migration docs

  See our convention rule.