feat: reviewpad onboarding

[reviewpad]

Welcome to Reviewpad! This is an onboarding pull request to help you configure Reviewpad before it starts speeding up and securing your pull requests.

To activate Reviewpad, merge this Pull Request. To disable Reviewpad, simply close this Pull Request unmerged.

Configuration

Reviewpad is configured by adding a reviewpad.yml to the root of your repository. This file contains a list of workflows that Reviewpad will use to automate actions on your pull requests. Each workflow is triggered based on some defined conditions called rules.

To get you started, we provide a default configuration (attached to this PR) with some best practices.

If you wish to tune this configuration, you can either use our embedded wizard by turning on/off the below checkboxes or simply edit the reviewpad.yml file in this branch and push it. If you decide to manually update the reviewpad.yml configuration file to get access to the full power of Reviewpad, the wizard and so the below checkboxes will vanish.

Please make sure to test your configuration before pushing it. You can run your configuration against a public repository using our Reviewpad Playground.

The workflows part of this default configuration are the following:

• Summarize the pull request on each push;
• Assign the pull request to the most relevant reviewers based on code authorship and reviewer availability;
• Greet contributors on their first pull request;
• Check conventional commits:
  • Check commits messages against the conventional commits specification;
  • Check pull request title against the conventional commits specification (useful if you squash merge pull requests);
• Best practices for pull request management:
  • Warn pull requests that do not have an associated GitHub issue;
  • Warn pull requests if their description is empty;
  • Warn pull requests that do not have a linear history (i.e. commits come after one another);
• Label pull requests based on their size to boost smaller pull requests;
• Label pull requests with waiting-for-review if there missing approvals;
• Label pull requests based on the type of changes:
  • Label pull requests with docs if they only modify Markdown or txt files;
  • Label pull requests with infra if they modify Terraform files;
  • Label pull requests with dependencies if they only modify package.json and package.lock files;
• Fail Reviewpad check on pull requests that modify any LICENSE;

What to Expect

With your current configuration, Reviewpad will perform the following automations in the last 2 open pull requests:

• Bump golang.org/x/text from 0.3.7 to 0.3.8 in /agent #8

  • Assign reviewer based on code authorship and reviewer availability
  • Lint commit messages with conventional commits
  • Lint pull request title with conventional commits
  • Add warning message "Please link an issue to the pull request"
  • Add label "large"
  • Add label "waiting-for-review"

• Bump golang.org/x/net from 0.0.0-20220728211354-c7608f3a8462 to 0.7.0 in /agent #9

  • Assign reviewer based on code authorship and reviewer availability
  • Lint commit messages with conventional commits
  • Lint pull request title with conventional commits
  • Add warning message "Please link an issue to the pull request"
  • Add label "large"
  • Add label "waiting-for-review"

Need help?

If you have any questions please check out our documentation or get in touch with us.

---

This PR has been generated by Reviewpad and it was triggered by the installation of the Reviewpad GitHub App.

[github-actions]

Message that will be displayed on users' first pull request

[reviewpad]

Reviewpad Report (Reviewpad ran in dry-run mode because configuration has changed)

📜 Executed actions

$assignCodeAuthorReviewers(1, [], 0)
$commitLint()
$titleLint()
$warn("Please link an issue to the pull request")
$removeLabels(["small", "large"])
$addLabel("medium")
$addLabel("waiting-for-review")