Skip to content

Issue Labels

Lucas Azzola edited this page Oct 1, 2017 · 23 revisions

List of active labels

Issue labels fall into the following groups.

Area

Areas are parts of the code-base that frequently have issues.

  • area:comments

    Comments are one of the most complicated parts of prettier. This label means the issue relates to how prettier is printing comments.

Difficulty

Difficulty is used to mark how much time it will likely take to resolve an issue, or how much nuance there is to a particular issue.

  • difficulty:easy

    This issue is easy. Resolve me on the train to work!

  • difficulty:hard

    This issue might take an entire weekend, or require a tough decision.

Language

Prettier supports a growing number of languages so it is useful to tag them.

  • lang:css/scss/less

    This issue affects CSS, LESS or SCSS.

  • lang:flow

    This issue affects Flow.

  • lang:graphql

    This issue affects GraphQL.

  • lang:jsx

    This issue affects JSX.

  • lang:javascript

    This issue affects JavaScript.

Priority

  • priority:high

    High priority issues are ones that either re-print code in a way that unintentionally changes the AST, or are significant regressions and need to be fixed urgently.

  • priority:facebook blocker

    Facebook use Prettier internally. Issues marked with this label block Facebook upgrading Prettier.

Status

Status labels are particularly useful for finding issues that need attention.

  • status:awaiting response

    In a pull request, this means a review has been left that requires the author to reply. On an issue, this means that a collaborator has replied and requires more information from the reporter to proceed.

  • status:has pr

    This issue has an accompanying PR. By excluding this label from your search it is easier to find actionable items.

  • status:help wanted

    Help! We're only a small group of collaborators who unfortunately can't get to every issue promptly. This label means we think the issue should be addressed but don't have the capacity to resolve it now. Great for first-time contributors!

  • status:needs discussion

    This issue needs discussion and ultimately a decision to be made before it is actionable.

Type

Issue types are categories that an issue might fall into. Generally an issue should have exactly one type.

  • type:bug

    Red alert! Issues with this label are bugs in Prettier. Most bugs are cases where Prettier does not produce the expected output. If the output means the code can no-longer be parsed, or the meaning of the code has changed, add the priority:high label, too.

  • type:docs

    This issue requires amending or adding new documentation.

  • type:editor support

    This issue pertains to ensuring Prettier provides the right tools to be used inside editor integrations.

  • type:feature

    Working as intended! Issues with this label represent a potential new feature to be added to prettier.

  • type:question

    Issues marked as questions are queries about how prettier works, or bug reports that are actually prettier working as intended.

Miscellaneous

  • dependency

    This is a real issue but cannot be solved by modifying Prettier itself, it must be fixed in one of our dependencies.

  • duplicate

    This issue is a duplicate of a previous issue.

  • external

    This issue cannot be resolved in Prettier itself, it is an issue with something external, such as an editor integration.

Clone this wiki locally