-
Notifications
You must be signed in to change notification settings - Fork 233
Labeling schema
New issues will be checked at least twice a week when newly staged content is published to the live server. The person doing the Merge to Live PR will check for new issues on Tuesdays and Thursdays. It is also a best practice to check your own content on a regular basis. While you shouldn't rely on the publishing process, at least you know that issues will be checked weekly.
Every new issue must be triaged: assign a label to the issue and assign to the appropriate person to resolve and close.
Opened An issue or PR is opened in GitHub Triaged One or more labels have been assigned. The issue/PR may also be assigned to an individual, or that step may require further investigation. In work A dialog is taking place – may be waiting on answers or more information, but the original poster is being engaged. Resolved The issue/PR is closed or merged, and may be tagged with additional labels indicating the type of resolution.
| Label | Resolution details |
|---|---|
| Area: XXX | Identifies area of Office development (for determining who to assign an issue to). Areas may be added as needed, and each area will have an assigned owner on the DevX team. -Add-in areas: Dialog API, Excel, Word, General Runtime, others TBD -Graph areas: Auth, SDKs, Graph Explorer, others TBD. |
| Blocker | This issue prevents the use of the API, technique, or sample. |
| Bug: Documentation | This issue describes a bug in published documentation or samples, which has been logged internally. |
| Bug: Product | This issue describes a bug in a Microsoft product or service, which the response coordinator has logged internally. |
| Bug: Sample | This issue describes a bug in a published sample, which the response coordinator has logged internally. |
| By Design | This item is working as intended (this category is a subset of Won’t Fix). |
| Duplicate | This issue has already been reported elsewhere; if possible, should provide a response that links to the original issue. |
| External | This issue is not directly related to Office Extensibility / Calc org’s responsibilities (e.g., an Edge bug). |
| Fixed | This issue has been addressed and resolved (should also be closed in GitHub UI). |
| Fun | Not a critical need, but addressing it may be fun/interesting. |
| Help Wanted | This is an interesting and possibly useful idea which the community could help with as an open source contribution. |
| High Impact | Issue that affects many use cases or makes a dramatic difference in perf/usability/etc. |
| Loc – localization issue | Identified by loc suppliers or response coordinator. |
| Needs More Info | A response has been posted asking the original poster for clarification; waiting on their response. Follow-up in a week, if no answer, then comment and close issue. |
| Not Actionable | This issue is not actionable, so no action will be taken. |
| Question | This is a question, and the response coordinator is tracking down an answer. |
| Request: Documentation | This is a request for new documentation, which the DevX team may take into consideration |
| Request: Feature | This is a request for a new feature, which the engineering team may take into consideration |
| Request: Sample | This is a request for a specific sample, which the DevX team may take into consideration |
| Resolved: Awaiting Validation | A fix has been made (and is available in an alpha/beta release). However, we’re asking the original poster to validate that this indeed fixes their issue. Use this for the less-straightforward or customer-environment-specific bugs]. |
| Resolved: Awaiting Prod Deployment | A fix has been made in Alpha/Beta, and is queued up for Production, but Production itself has not yet deployed. |
| Simple | Resolving the issue will require minimal work; use to search for “low-hanging fruit” that can be addressed quickly and close. |
| Stack Overflow | Resolve by referring customer to Stack Overflow. Use boilerplate in comment: "Please post this question in Stack Overflow and tag it with office-js? Stack Overflow a good forum for receiving technical support on the API. This repository is specifically for errors/issues with the documentation set rather than the API itself. While there is overlap, questions regarding the use of the API should be posted on Stack Overflow where you'll likely get a quicker response and benefit other developers facing the same challenges. Be sure an include a complete description of your problem and the code you're using to make the call. Without enough detail the community won't be able to provide any guidance." After you reply to the customer, you can close issue. (You can also head over to Stack Overflow to discuss there!) |
| Under Investigation | Response coordinator (or a person they’ve reached to internally) is looking into this item. |
| Won’t Fix | Issue has been researched and no action will be taken (a friendly explanation of the reason should be provided). |
Some labels (e.g., Fixed/Not Actionable/Won't Fix) are intended primarily for reporting on closed issue after the fact. GitHub's web UI makes it easy to filter on labels. The "Under Investigation" label can be used to view all such issues in aggregate (as opposed to searching for issues assigned to a specific person).
Not Actionable vs. Won't Fix: Not Actionable = there is not a clear request for a specific change. Won't Fix = there is a specific change requested, but we have decided that the change is not in the best interest of the broader community.