<aside> 💡

This document outlines the rules that SHOULD or MUST be followed before creating, requesting reviews or merging a pull request in the safe-docs repository.

</aside>

Before creating a PR

Status

• If the feature or change is not finalized, it MUST be opened as a Draft.

Target branch

• It MUST target the main branch, unless the content is not meant for release in the near feature or the task will be approached in multiple pull requests.

Title

• The title MUST follow the Conventional Commits specification. Examples:
  • feat(networks): Add supported networks page
  • docs(safenet): Add overview page
  • fix(protocol-kit): Update parameters in X function in the reference
  • refactor(react-hooks): Split the guide for sending transactions
  • chore: Update dependencies
  • style(relay-kit): Format code snippet
  • ci: Fix deployment script for staging
  • revert(safenet): Remove Safenet documentation

Content

• It MUST follow the GitHub PR template.
• It MUST include a clear and complete description of all changes.
• It SHOULD NOT include changes that are out of the scope.

Before adding reviewers to a PR

Status

• It MUST NOT be a Draft pull request.

Links

• It MUST NOT include broken links.
• All the redirects MUST be updated (if applicable).

Grammar and format

• All the text MUST be checked with Grammarly.