🤖 ez-pr-bot

EZ PR Bot is a Slack bot that accelerates the PR review process for your team!

Table of Contents

1. Why
2. Getting Started
   • Project Structure
   • Installation
   • Contributing
3. Usage
4. Planned Work
5. License

Why

Getting your code changes reviewed can be more laborious than it should be.

EZ PR Bot solves this by encapsulating the entire code PR review workflow into a simple shortcut, that makes them actionable and trackable.

Getting Started

Project Structure

.
├── src
│   ├── cmd                         # General use commands, such as getNameByID and openModal [4]
│   │    └── index.ts               # Exports the <cmd> subpackages for simplication of import stmts
│   ├── ezpr
│   ├── help
│   ├── errors                      # Error classes to communicate issues to users
│   ├── parse                       # Functions related to parsing command args, form inputs, etc.
│   ├── types                       # Contains various relevant type declarations and zod parsing schemas
│   ├── app.ts                      # Slack Command/Action handlers
│   └── parse.ts                    # Parsing utility functions
├── manifest.yml                    # The Slack App configuration
└── README.md                       # You are here! :)

Installation

See: docs/setup.md

Contributing

We welcome all contributions! If you identify any bugs or have an idea for a feature request, please create a Github issue and verify that it does not exist already.

EZ PR Bot follows trunk-based development.

──────────────────────── main ────────────────────────────────────    # Deployments
        │                                   │
        └─────────── feat/[feat-name] ──────│                         # Dev branches

Dev branches should be appended with an indicator to describe the type of work being done, including but not limited to: feat, fix, refactor, tweak, docs, chore

Featurework

1. git checkout -b <type>/[name]
2. Write your code
3. Open a PR from that branch to main
4. Fill out the pull request template accordingly
5. To be approved, code must have adequate test coverage + formatted properly
6. Commits should be squashed when merged

🖼️ Planned Work

See our Github projects for an updated look at our planned/upcoming work, but here's our planned roadmap.

.
├── V0.5.0 - CLI
│   ├── /help
│   ├── /ezpr
├── V1.0.0 - Interactivity via UI
|   ├── Forms/modals for easier use of /help, /ezpr, etc.
├── V2.0.0 - Extended capabilities
|   ├── Shortcuts compatibility
│   ├── /statistics: view stats for your PRs/your team's PRs e.g. time-to-merge, time-to-approve, actual-review-time
│   ├── /prs: view a list of open prs that require your review
│   ├── /reminders: send reminders to assigned reviewers if PR still open after X time or next work day
│   └── /assign: assign reviewers to your PR or randomly choose from a role

Some other ideas still under evaluation:

• Urgency: Communicate to reviewers that this PR is urgent, maybe it'll dm the team
• If 5 mins ETR selected —> assign reviewer(s) —> DM reviewer(s)
• Github integration: inform that PR needs re-review after changes are pushed

📚 References

• https://github.com/glamboyosa/PRBot
• https://www.upsilonit.com/blog/create-a-slack-bot-with-typescript-in-3-steps#step-1-initial-slack-bot-setup
• https://www.freecodecamp.org/news/how-to-build-a-basic-slackbot-a-beginners-guide-6b40507db5c5/
• https://refactoring.guru/design-patterns/command
• https://slack.dev/bolt-js/deployments/aws-lambda

🏁 License

Distributed under the GNU GPL-3.0 License. See LICENSE for more information.