Ontology: Restructure and document GitHub labels

Created on 1 Apr 2020  路  20Comments  路  Source: OpenEnergyPlatform/ontology

Description of the issue

I find the selection of possible Issue-Labels quite confusing. There is no clear rule for the use of labels.

Ideas of solution

Discuss, update and document existing labels.
Add a section to the CONTRIBUTE.md
Change label colours.

Workflow checklist

  • [x] I am aware of the workflow for this repository
  • [x] I added this issue to the Project 'Issues'. If suitable, I add it to further Projects.
organisation

Most helpful comment

The _requirement_specification_ and _specification_sheet_ come from the requirements analysis in the SzenarienDB project. Keep one of them and drop the other?

requirement_specification has just two issues, one of them being this one, so delete that one?

All 20 comments

ok, all labels:
frequently used

  • issue type: [A] new term, [B] restructure, [C] definition update
  • concerned module: oeo-model, oeo-physical, oeo-social
  • concerned topic: Energ carriers and fuels, extern ontology, geographic
  • other: bug, ready for implementation (self explanatory)

I propose to delete

  • class missing: this seems duplicate to our issue type [A] new term, delete?
  • duplicate: I always just close duplicate issues, delete?
  • invalid: same as bug?
  • help wanted: who should look for this? We most times just tag people who could be of help. Delete?
  • relation missing: don't see use case, delete?

organisation, project management

  • organisation
  • requerement_specification, specification_sheet: Projektorganisation
  • SzenarienDB: not only the ontology, more general issues
  • Time-L. Urgency-S

the rest:

  • enhancement
  • good first issue
  • question
  • wontfix

We don't really work in the classic "project meeting,decide what to do - work phase, implement" way with requirement_specification and specification_sheets that get worked off.
So maybe organisation or SzenarienDB is enough in the third category?

To the "change colors" part: Should related labels like oeo-model, oeo-physical and oeo-social rather have the same or similar colors to show their relation or different to differentiate the issues?

ToDo: Rename label 'oeo telko' to 'oeo dev meeting'

I propose to delete
class missing: this seems duplicate to our issue type [A] new term, delete?
duplicate: I always just close duplicate issues, delete?
invalid: same as bug?
help wanted: who should look for this? We most times just tag people who could be of help. Delete?
relation missing: don't see use case, delete?

I agree.

The requirement_specification and specification_sheet come from the requirements analysis in the SzenarienDB project. Keep one of them and drop the other?

I propose to delete
class missing: this seems duplicate to our issue type [A] new term, delete?
duplicate: I always just close duplicate issues, delete?
invalid: same as bug?
help wanted: who should look for this? We most times just tag people who could be of help. Delete?
relation missing: don't see use case, delete?

I agree.

I agree, too.

I propose to delete
class missing: this seems duplicate to our issue type [A] new term, delete?
duplicate: I always just close duplicate issues, delete?
invalid: same as bug?
help wanted: who should look for this? We most times just tag people who could be of help. Delete?
relation missing: don't see use case, delete?

I agree.

I agree, too.

I deleted them now

The _requirement_specification_ and _specification_sheet_ come from the requirements analysis in the SzenarienDB project. Keep one of them and drop the other?

requirement_specification has just two issues, one of them being this one, so delete that one?

ToDo: Rename label 'oeo telko' to 'oeo dev meeting'

done

I deleted requirement_specification now.

Anything else to change with the labels, any recolor-ideas maybe?

I think we could delete the _ontology_ label. Everything issue in this repo should be somehow related to ontologies as it is the onotology repo. 馃槂

Additionally: The label _extern ontology_ should be renamed to _external ontology_.

I think we could delete the _ontology_ label. Everything issue in this repo should be somehow related to ontologies as it is the onotology repo. 馃槂

that makes enough sense that I spared the discussion part and deleted it.
I renamed too like you proposed.

What about the deletion of 'Time-L.' and 'Urgency-S'? I'd prefer a label 'high urgency' or something like that.
edit: We already have 'bug' for that, sorry.

Those are SzenarienDB project wide labels from the requirements analysis. If we change it for the ontology repo we should also change these in the other repos.

What about

  • 1 colour (or three similar colours) to all issue type labels
  • 1 colour (or three similar colours) to all oeo-subontologies?
    Something bright, because they are important?

I like the idea of similar colours.

I changed to:

  • green shades for issue types
  • blue shades for ontology modules
  • purple for themes
  • yellow to red for the rest
  • I left the ScenarienDB project labels as they were

as there's no more discussion I'll close

Was this page helpful?
0 / 5 - 0 ratings