Skip to content

Guidelines for creating and triaging issues

Harald Schilly edited this page May 21, 2017 · 3 revisions

Issues need to be individual doable tasks that are very specific about exactly what is to be changed to CoCalc. Don't make issues which are a bunch of tasks. Instead create projects https://github.com/sagemathinc/cocalc/projects/new and then issues for each task.

Issue Triage

For the most part, we mimic Rust's triage system.

Contributors with sufficient permissions on the CoCalc repo can help by adding labels to triage issues:

  • Yellow, A-prefixed labels state which area of CoCalc the issue relates to.

  • Green, E-prefixed labels explain the type of experience necessary to fix the issue.

  • Red, I-prefixed labels indicate the importance (relevance) of the issue. The I-nominated label indicates that an issue has been nominated for prioritizing at the next triage meeting.

  • Orange, P-prefixed labels indicate a bug's priority. These labels are only assigned during triage meetings, and replace the I-nominated label.

  • The purple meta label denotes a list of issues collected from other categories.

  • The black, blocked label denotes an issue blocked by another.

If you're looking for somewhere to start, check out the E-easy tag.

List of labels and their descriptions

Most tags should be self explanitory but some can be unclear. If you're unsure what a label means how it's different from another just ask (Where??). We'll probably add it to the description here.

  • blocked -- Always link what the issue is blocked by.
  • I-bug -- Something that is clearly wrong based on what the UI tells you or on strongly expected behavior by the majority of people.
  • I-enhancement -- Making something in CoCalc better.
  • I-feature request -- Adding some new component to CoCalc
  • I-slow -- Something that seems unnecessarily slow.
  • I-software request -- Requests for adding something to be installed in CoCalc by default.
  • I-UA -- Text that needs to be reworded or a tip that needs to get written.
Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.