For issue management, we’ll be using Github issues (Issues
tab) & Github projects (Projects
tab, Dev
project. Assigned tasks will appear in the
Todo, assigned issues with
No Statusare hold off until further notice. If an issue is urgent, it will be tagged accordingly.
priority: low,
priority: medium,
priority: high` are the tags.
Once you are ready to start on an issue do 2 things.
Todo
to In Progress
To commit messages, you may run pnpm commit
for an interactive CLI to guide you through proper formatting.
If you are new to the project, you’ll be assigned an issue created by me or any of the team. But as you become more familiar with the project. We encourage you to create your own issues. Only the type
and scope
are required when creating an issue.
Issues fall under these main top level categories:
These tags describe the nature of the work required for an issue. Some possible types of work might include:
bug
: for issues that involve fixing a problem in the existing code.feature
: for issues that involve adding new functionality to the code.enhancement
: for issues that involve improving existing features or code.documentation
: for issues that involve writing or updating documentation.refactoring
: for issues that involve restructuring existing code without changing its behavior.test
: for issues that involve writing or updating tests.These tags describe the current status of an issue. Some possible statuses might include:
needs-triage
: for new issues that have not yet been evaluated or assigned.