-
Notifications
You must be signed in to change notification settings - Fork 3
Issue and PR Labels
Motorcycle.ts makes use of a number of issue and PR labels to communicate the type, status, scope, priority, and size of issues and pull requests. Here we will try to go in-depth about what each label category means and if required each individual label.
Labels belonging to the Scope category are meant to represent where in the Motorcycle code base is the issue addressing, or what package the changes of a PR are being made.
This issue label is for issues that do not affect any particular package but affects the monorepo as a whole. This could be a upgrading a devDependency in the root package.json or adjusting a build script.
This issue label is for all changes that affect @motorcycle/types
This issue label is for all changes that affect @motorcycle/stream
This issue label is for all changes that affect @motorcycle/run
This issue label is for all changes that affect @motorcycle/test
This issue label is for all changes that affect @motorcycle/dom
This issue label is for all changes that affect @motorcycle/html
This issue label is for all changes that affect @motorcycle/history
This issue label is for all changes that affect @motorcycle/router
This issue label is for all changes that affect @motorcycle/http
This issue label is for all changes that affect @motorcycle/storage
This issue label is for all changes that affect @motorcycle/i18n
This issue category is used for defining what an issue is for.
For issues that require discussion.
For issues that report bugs in a package or packages.
For issues that suggest a feature
For issues that, if accepted, would be a breaking change to a package or packages.
For issues that are not source code changes. e.g. A NPM script adjustment or updating a dependency.
For issues that represent a regression between releases
For issues that are simple questions
Status labels are used to represent at what stage an issue is currently at. e.g. If an issue needs more information from the original poster or is actively being worked on.
For all issues that are blocked by the resolution of another issue
For issues that community contributions would be most graciously accepted
For issues that are actively being worked on. These issues should also be assigned to the user working on that issue.
For an issue does not have enough information to help other solve and close that issue
For pull-requests that are made but are missing one or more testcases.
For issues and pull-requests that need more input from other contributors.
For bug report issues that have not yet been reproduced by another contributor
For issues that have a PR ready for review
For issues or PR's that are actively under review
When an issue is closed without a corresponding PR it will be given a Resolution label. A resolution is not final and can be later remove and the issue reopened if required.
When an issue is reporting a bug, but that bug cannot be reproduced or a simple test case can not be found, it will be close and given this label and closed.
When an issue is reporting a bug, and that bug has been fixed, it will be given this label and close.
When an issue is reporting a possible change or bug but the proposed change is disagreed upon, it will be given this label and close.
The size of an issue is how much work is required to close that issue. 1 being more beginner-friendly with a smaller amount of work required, and 4 being the largest likely requiring more knowledge of the code base.
This priority of a task where 1 is urgently needed and 4 is the least urgent.