Thanks for taking the time to contribute — your help makes this project better.
This document explains how to get the project running locally, the preferred workflow, and what we look for in pull requests.
- Fork the repository and clone your fork.
- Create a descriptive branch from
main:
git checkout -b feature/awesome-feature
- Make small, focused commits. Use clear messages (see Commit message style).
- Push your branch and open a Pull Request against the
mainbranch.
- For setup the project locally, please refer to the README file.
Use clear prefixes:
feature/<short-description>— new featurefix/<short-description>— bugfixchore/<short-description>— maintenancedocs/<short-description>— documentation only
Keep branch names short, lowercase, and hyphen-separated.
We prefer conventional, concise commit messages. Example:
feat(auth): add refresh token endpoint
fix(task): reject invalid due dates
docs(readme): clarify setup steps
Start with a type (feat, fix, docs, chore, refactor, test) followed by an optional scope and short description.
- TypeScript code should follow the existing project conventions.
- Run
npm run formatbefore committing. - Run
npm run lintand address issues flagged by ESLint. - Keep functions small and well-named. Add comments for non-obvious logic.
- I'll add unit tests for existing/new logic under
__tests__in the future insha'Allah, and you should too!
When opening a PR, please include:
- A descriptive title and summary of changes.
- Link to any related issue (e.g.
Closes #123). - Steps to reproduce or validate the change.
- Notes on any environment changes.
Reviewers will check tests, linting, and overall before merging.
- Open a new issue for bugs or feature requests. Provide steps to reproduce, expected vs actual behaviour, and any logs or stack traces.
- Don't commit secrets or environment variables. Use
.envfile and.env.examplefor reference.
🚀 Thank you for contributing — we appreciate your time and effort!