Describe pull request workflow

[l-emele]

Description of the issue

Describe somewhere (either in CONTRIBUTING.md or the wiki) the workflow within a pull request.

Ideas of solution

Topics:

• Draft vs ready for review
• Assigning reviewers
• What should reviewer check?
  • Right classification and axioms
  • Spelling and grammar of definitions
  • CHANGELOG.md
  • Term tracker items
  • ...

Workflow checklist

• I am aware of the workflow for this repository

[markus-rothkoetter]

additional topic suggestions:

• What do the automated checks do?
• Is protégé configured for numerical identifers?
• usage of automatic closing for issues

[l-emele]

I did a first draft here: https://github.com/OpenEnergyPlatform/ontology/wiki/Pull-request-workflow

[markus-rothkoetter]

Once the wiki-entry is finished:
Shall we exchange the "Review"-section in CONTRIBUTING.md for a brief description ("Our PR-workflow is special due to term tracker ... ") and a link to the wiki?

This would ...

• .. decrease maintenance effort (divide-and-conquer)
• ... ease the onboarding of new users as they aren't overwhelmed by a super-sized CONTRIBUTING.md (overview-first, details-on-demand)

[l-emele]

That is a good idea, the CONTRIBUTING.md is very long.

[markus-rothkoetter]

I did a first draft here: https://github.com/OpenEnergyPlatform/ontology/wiki/Pull-request-workflow

I adjusted the wiki sidebar-link to lead to that page the old one hit a non-existent page ("-workflow" was missing in the link)
Additionally, I think it's good to a a small indicator to show if a wiki page is work in progress. (like 🚧 in the sidebar-entry)

I haven't been able to clone the wiki locally, so shall I work on the live-version of the wiki when I'm extending your draft @l-emele ?

[l-emele]

I adjusted the wiki sidebar-link to lead to that page the old one hit a non-existent page ("-workflow" was missing in the link) Additionally, I think it's good to a a small indicator to show if a wiki page is work in progress. (like 🚧 in the sidebar-entry)

Basically everything in the wiki is work in progress...

I haven't been able to clone the wiki locally, so shall I work on the live-version of the wiki when I'm extending your draft @l-emele ?

That is fine. Git pushes and live edits are here basically the same, as there aren't pull requests or something similar for the wiki.

[markus-rothkoetter]

Basically everything in the wiki is work in progress...

I created a new issue #1106 in order to tackle this step-by-step.

That is fine. Git pushes and live edits are here basically the same, as there aren't pull requests or something similar for the wiki.

Good to know. Then I'll add further refinements to the page later.
I think to incorporate the content from the section in CONTRIBUTING.md is a good starting point.

[markus-rothkoetter]

Closing this as the wiki-page 📚 is at 90 % completion.

Only references to other pages and minor content additions are missing.
I'll monitor these in the wiki-toplevel issue #1106