moja-global / moja_global_docs

Repository to host the moja global technical documentation
https://docs.moja.global/en/master/
Mozilla Public License 2.0
35 stars 67 forks source link

Describe the labels. #79

Open shloka-gupta opened 3 years ago

shloka-gupta commented 3 years ago

Describe how we are communicating and why it is not optimal.

The labels haven't been described properly. A new contributor may have difficulty understanding what a particular label means.

Describe the solution you'd like.

A volunteer could coordinate with @HarshCasper and create a table with contents:

Label Name | Description | Colour

Fill it up and then someone from the docs team can edit the labels.

Describe alternatives you've considered.

--

Additional context.

Open to suggestions or better ways to complete the label's description.

shloka-gupta commented 3 years ago

@shubhamkarande13 I wonder if it should be assigned directly to @HarshCasper or not.

Although, @HarshCasper can do it directly, and that may be more time efficient.

Pro of a new comer being involved is that it may help them feel more involved and welcomed.

Con is obviously that it may be time consuming.

raghavraj-27 commented 3 years ago

I would like to work on it @chicken-biryani Please assign it to me.

raghavraj-27 commented 3 years ago

Thanks @chicken-biryani I am creating a doc and a table in it and starting to fill the tables with the labels and will complete it with the help of @HarshCasper, once the table get filled completely I'll put up its link here.

@HarshCasper, is that would be okay ?

raghavraj-27 commented 3 years ago

Hey, I found this document while digging up.

shloka-gupta commented 3 years ago

Hey, @raghavraj-27 that's really cool. Great job! Gives us a good lead.

However, what I am concerned about:

1) Some labels have the same function. For example: The labels documentation and cat = doc, Both deal with documentation.

2) The same labels aren't used across all the repositories/projects. Inconsistency may lead to problems.

So we just need to think about the labels we want and don't want.

We could first have a look at the labels that are getting used in the community website and FLINT. .

Let's keep the extra labels on hold for now, and discuss them with @HarshCasper and @shubhamkarande13 later.

HarshCasper commented 3 years ago

Hi @raghavraj-27 @chicken-biryani

The purpose of this issue is to make sure that our GitHub issue labelling process is consistent. Right now, we follow vastly different issue label configurations on different projects (take for an example community website and/or FLINT).

Since we have so many repositories, we should come up with a reasonable set of standard labels that are suitable for our needs. The trick will be not to have TOO many labels.

I also found some good links:

We should make some decisions on if we want to use emoji in Labels and how non-Label tags might be used (in particular, Milestones and Projects)

Once decided, we can simply add all of those labels in the respective repos using this script (some dummy data is being used to show the purpose):

[
  {
    "name": "Type: Help Needed",
    "color": "5319e7"
  },
  {
    "name": "Priority: Critical",
    "color": "ff2222"
  },
  {
    "name": "Priority: High",
    "color": "FF7922"
  },
  {
    "name": "Priority: Low",
    "color": "c2e0c6"
  },
  {
    "name": "Priority: Medium",
    "color": "fbca04"
  },
  {
    "name": "Status: Complete",
    "color": "7ED321"
  },
  {
    "name": "Status: Confirmed",
    "color": "0e8a16"
  },
  {
    "name": "Status: Feedback Needed",
    "color": "006b75"
  },
  {
    "name": "Status: In Progress",
    "color": "FC8264"
  },
  {
    "name": "Status: On Hold",
    "color": "BABABA"
  },
  {
    "name": "Status: Review Needed",
    "color": "EAE435"
  },
  {
    "name": "Type: Bug",
    "color": "ff2222"
  },
  {
    "name": "Type: Enhancement",
    "color": "1d76db"
  },
  {
    "name": "Type: Feature",
    "color": "6DFF6D"
  },
  {
    "name": "Type: Idea",
    "color": "6DE6FF"
  },
  {
    "name": "Type: Question",
    "color": "FF6DD9"
  }
].forEach(function(label) {
  addLabel(label)
})

function updateLabel (label) {
  var flag = false;
  [].slice.call(document.querySelectorAll(".labels-list-item"))
  .forEach(function(element) {
    if (element.querySelector('.label-link').textContent.trim() === label.name) {
      flag = true
      element.querySelector('.js-edit-label').click()
      element.querySelector('.js-new-label-name-input').value = label.name
      element.querySelector('.js-new-label-color-input').value = '#' + label.color
      element.querySelector('.js-edit-label-cancel ~ .btn-primary').click()
    }
  })
  return flag
}

function addNewLabel (label) {
  document.querySelector('.js-new-label-name-input').value = label.name
  document.querySelector('.js-new-label-color-input').value = '#' + label.color
  document.querySelector('.js-details-target ~ .btn-primary').disabled = false
  document.querySelector('.js-details-target ~ .btn-primary').click()
}

function addLabel (label) {
  if (!updateLabel(label)) addNewLabel(label)
}

Tagging @aornugent @shubhamkarande13 @sarthakkundra to understand what their opinion would be.

raghavraj-27 commented 3 years ago

As of now for this particular repo, I have prepared this doc as said in the issue and tried to put a satisfying description for each label. Please have a look! I think corrections are needed to it. Please comment in the doc. Doc link -> https://docs.google.com/document/d/19KBNLnTdr3xCWE60z_5b8iVNpNRaa8S67YRR96pCw8g/edit?usp=sharing

aornugent commented 3 years ago

I like this @raghavraj-27.

Generally fewer labels is better. Maybe we don't need the 'assigned' label (instead use Github assignment) or the time estimate labels (T=1 etc)? Please also reconcile with: https://github.com/moja-global/About_moja_global/labels and https://github.com/moja-global/FLINT/labels

shloka-gupta commented 3 years ago

Hey, @raghavraj-27 you've done a great job. Must have taken a lot of effort. Thank you for putting in the time.

Here's a suggestion - Maybe, you could add more columns. 1) A column named Eliminate- This will help us decide whether we are supposed to eliminate that label or not. 2) Two columns namely, FLINT and About moja global. Under this column, you can note down whether the specific repository has that label or not.

For example:

Label Description Color Eliminate FLINT About moja global
T=1 hour Resolving this will take 1 hour time Purple Eliminate 1 0
Document Adding or updating documentation. Blue - 0 0

In the example :

1) I have used 0 - not there and 1 - there. 2) I have made the values for FLINT and about moja global as 0. Because: In FLINT the description is "Issue/feature refers to docs, not code" and in About_moja_global it's "Doc" and not "Documentation."

raghavraj-27 commented 3 years ago

Thanks @aornugent and @chicken-biryani for the review. I have tried to reconcile with the FLINT and About-moja-global repo. I have added two more columns named FLINT and About-moja-global and also a sub column in both of them to show the colors of the respective labels of particular repo. A Eliminate column is also there and I have marked some labels which can be eliminated.

image

One thing I am observing that some labels like let say Help-Wanted has different color in FLINT and different color in About-moja-global and some more variations I am observing. Also take a closer look to P1, P2 in the doc. I have highlighted those variations in the comment of the doc itself.

Here is the doc link -> https://docs.google.com/document/d/19KBNLnTdr3xCWE60z_5b8iVNpNRaa8S67YRR96pCw8g/edit?usp=sharing

Please review once again.