• How to set up a new project
  • Manual steps with integration
  • Manual steps without integration with pkode
    • Bots
      • Setup Kodiak bot
      • Setup All Contributors bot
    • GitHub templates
      • Issue templates
      • Pull Request template
  • TODO

• Jest
• Playwright

Adopted from the official Quickstart guide.

1. Install the GitHub app to the repository
2. Copy .kodiak.toml file to the root directory
3. Configure GitHub branch protection
4. Create an automerge label (default: "automerge")
5. Start auto merging PRs with Kodiak
   Label your PRs with your automerge label and let Kodiak do the rest! 🎉

1. Install the Bot to your project
   Check the installation documentation for how to add it
2. Start a pull request or comment
3. Mention the @all-contributors Bot
4. Add a contributor’s username and contribution type
   Check the contribution types in the Emoji Key Cheatsheet
5. Post and your README.md updates automatically! It'll add the Contributor Table for your first time, too.

1. Copy the whole ISSUE_TEMPLATE directory
2. Paste it under .github directory in the repository

1. Copy the pull_request_template.md file
2. Paste it under .github directory in the repository

TODO: Document these manual steps which require no integration with pkode

• Git pre-commit hooks using husky
• Commitlint configuration
  • Install commitlint
  • Integrate with husky
  • Test integration with husky
• All Contributors integration
• Kodiak bot
• GitHub Issue and Pull Request templates