Labels Wiki

Labels in this repository are used like tags and meta-tags on Stack Exchange:

• #DDDDDD (silver) labels relate to features.
• #FEFEFE (off-white) and #E11D21 (red) labels serve the same purpose as on Meta SE sites.

---

Categorization Labels

These labels serve as a simple categorization of the issue they pertain to. Each issue should have at least one of these labels.

• [bug] - We have no bugs. Use this label to indicate you've found an undocumented feature with side-effects 😉
• [enhancement] - Use this label to request enhancements to Rubberduck. This may be new features (equivalent to the [feature-request] label on SE) or just updates to existing features.
• [support] - Use this label for issues asking for support using the Rubberduck add-in, or working with the code.
• [discussion] - Use this label when you need a rubberduck to talk to. Also use this label to solicit discussion on larger topics. This label may be used for aggregate issues that span multiple different other issues.
• [meta] - Use this label for anything relating to the repository itself, the ReadMe file and Wiki pages.

In addition to these labels, we're using the following labels to indicate useful information about the issue they're attached to:

• [critical] - no fix, no release. Simple as that. To be applied for bugs that result in code breaking, as well as bugs that result in host crashes, corruption, and similar catastrophic scenarios.
• [up-for-grabs] - Things we'll end up implementing ourselves if no one submits a PR for. These issues will have a difficulty label applied to them. Consider all issues labelled with that as soliciting a pull request from anyone 😄
• [difficulty-*] - There is roughly four difficulty levels to working on Rubberduck. Quoting CONTRIBUTING.MD:

  If you're new to C#, we recommend you start with [difficulty-01-duckling]. The next step [difficulty-02-ducky] requires some knowledge about C#, but not so much about how Rubberduck works

  Then there's [difficulty-03-duck] which requires a good handle on C# and at least an idea of how the components of Rubberduck play toghether. And finally there's [difficulty-04-quackhead] for when you really want to bang your head against the wall. They require both good knowledge of C# and a deep understanding of how Rubberduck works.

Status Labels

When issues are closed, these labels indicate the resolution of the issue without needing to explicitly check into the issue itself.

• [duplicate] - We'll use this label to identify dupes.
• [help-wanted] - This label indicates that we're dreaming of a pull request.
• [status-by-design] - Issues ("Bug") with this label aren't bugs, they're actual features. No kidding.
• [status-declined] - "Feature request" issues with this label are not going to happen. For "Bug" issues, this means "won't fix" :)
• [status-deferred] - Issues with this label will be shipped in 6 to 8 weeks.

Others

All other labels are basically navigational. They help searching through the issues better, because components relating to the issue are outlined with them. Furthermore they may help us organize issues into categories. The following is an excerpt of the labels we use

• [api] - Use this label for issues & features related to the COM-visible Rubberduck API.
• [code-explorer] - Use this label for issues related to the Code Explorer feature.
• [code-inspections] - Use this label for issues related to the Code Inspections feature.
• [code-parsing] - Use this label for issues related to parsing VBA code, but not necessarily with the ANTLR-generated parser.
• [code-review-integration] - Use this label for issues related to posting VBA code on Code Review Stack Exchange as a new question, integrating with the Stack Exchange API, or anything more or less in that line of thought.
• [indentation] - Use this label for issues related to the Indenter feature.
• [installer] - Issues with this label relate to the Rubberduck setup executable.
• [module-and-procedure-attributes] - Use this label for issues related to the Module & Procedure Attributes feature.
• [refactorings] - Use this label for issues related to any refactoring feature.
• [settings-config] - Use this label for issues related to the Settings & Configuration feature.
• [todo-explorer] - Use this label for issues related to the Todo Explorer feature.
• [unit-testing] - Use this label for issues related to the Unit Testing feature.
• [user-interface] - Use this label for issues that affect elements of the UI.
• [antlr] - Use this label for issues related to the ANTLR grammar file, or about implementation or usage of ANTLR-generated files.