Add Yourself as a Contributor - OpenEnergyPlatform/ontology GitHub Wiki

Overview

This page describes ...

how get access rights to the repository
how add yourself as contributor to the ontology This is necessary for the numerical identifers used in the ontology.

Please note: The following steps are designed not only to add yourself as a contributor but in same time represent your very first material contribution to the ontology itself. Going through the process and finishing it successfully ensures you, that you can contribute to the OEO in a proper way.

This workflow is ...
... predecessor of	numerical-identifer set-up

Note: Before starting the workflow below, please take a close look at the OEA ontology course and introduce yourself in an oeo-dev meeting.

Workflow

🐙 Become a member of the GitHub-Teams
- Use the OEP - Contact Form to request access. Please name your GitHub Handle and the corresponding team(s) you want to be part of.
- If you are already a member of the Open Energy Family Organisation, directly contact one of the members of the @oeo-community-manager.
By being added you gain the access permission needed to work on this repository. You have to accept the invitation first! Otherwise the next steps will partially not work.
🔶 Clone the ontology to your local machine
Check for next available user-id via ...
- 🐙: Look for open issues concerning adding new users AND
- 🐙: Look for open pull-requests concerning adding new users AND
  - 📙: Open the oeo.omn-file and look in the "Active ontology tab" for the latest dc:contributor-annotation OR
  - 📝: Open the oeo.omn-file and search for the latest dc:contributor-annotation
🐙 Create an issue for your user-id Name the issue Add new contributor/user and append the next available user-id (latest entry + 1) as a four-digit number
🔶 Create branch named feature-YourIssueNumber-add-new-contributor from dev Use either ...
- GitHub-Desktop or
- the command line via git checkout -b feature-YourIssueNumber-add-new-contributor Quick-Tip 🔎: The naming is consitent with our Git-convention 🏷TODO/ADD_LINK
📙 or 📝 Add yourself as a contributor in the ontology
- Create a dc:contributor-annotation in the oeo.omn-file according to the following pattern: 0000 FirstName LastName (@GitHub-username) (0000 is to be replaced by your new user-id!)
- Add yourself in CITATION.cff using a text editor.
🔶 Stage, commit and push the new changes (you don't need to add a term-tracker this time) Use either ...
- GitHub-Desktop or
- the command line via git push --set-upstream origin feature-YourIssueNumber-add-new-contributor
🐙 Create a pull-request and wait for acceptance
🐙 After being accepted, merge pull request
🐙 Delete branch
You obtained your contributor-id, adjust the numerical identifiers now Follow the next guide to adjust your Protege settings to numerical identifiers.

This page is based on #1094