feat: add reviewpad.yml file

[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.

The workflows part of this default configuration are the following:

• Praise contributors based on their contributions:
  • Greet contributors on their first pull request;
  • Praise contributors on their 100th 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;
• Automatically assign a random reviewer when the pull request is ready for review;
• 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;

If you wish to change it, simply edit the reviewpad.yml file in this branch and push it. Please make sure to test your configuration before pushing it. You can do it by running your configuration against a public repository using our Reviewpad Playground.

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.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
stackie-2023-resolution	✅ Ready (Inspect)	Visit Preview	Jan 9, 2023 at 7:15AM (UTC)

[reviewpad]

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

📜 Executed actions

$commentOnce($sprintf("Thank you @%s for this first contribution!", [$author()]))
$commitLint()
$titleLint()
$warn("Please link an issue to the pull request")
$removeLabels(["small", "large"])
$addLabel("medium")
$assignRandomReviewer()
$addLabel("waiting-for-review")