How to Contribute
We welcome contributions of all sizes! Whether you are fixing a typo, improving the UI, or building a new trigger integration, this guide will help you get your code merged.
Find a Task
We use GitHub Milestones to organize upcoming releases. Before starting, check the Active Milestone to see what work is prioritized.
Look for issues labeled good first issue or help wanted if you are new to the project.
Fork the Repository
You cannot push directly to the main repository. You must create your own copy (fork) to work on.
- Click the Fork button in the top-right corner of the GitHub repo.
- Clone your fork locally:
git clone https://github.com/YOUR_USERNAME/octogriffin.gitFollow our guide to configure Docker, Ngrok, and the GitHub App.
Branching Strategy
Create a new branch for your work. Do not commit directly to your fork's main branch.
feature/add-new-triggerfix/auth-redirect-bugConventional Commits
We use Release Please to automate versioning. For this to work, your commit messages must follow the Conventional Commits specification.
Good Examples
- feat: add new habitica trigger
- fix: resolve webhook timeout issue
- docs: update setup guide
- chore: bump dependencies
! after the type (e.g., feat!: drop support for v1 api).Development Standards
UI Components
Use the existing UI components in src/components/ui whenever possible. Do not hardcode colors; use Tailwind classes like text-slate-600 or bg-violet-50 to ensure the theme remains consistent.
Icons
We use Hugeicons React (Free). Always use the standard stroke variant. Do not use premium styles like bulk, solid, or twotone.
Open a Pull Request
When your code is ready, push your branch to your fork and open a Pull Request against main.
- Ensure the build passes locally.
- Link any relevant issues (e.g., "Closes #123") in the description.
- If you added a new feature, please include a screenshot or video.
git push -u origin feature/my-cool-feature