search

OpenEnergyPlatform / academy

The Open Energy Academy is a collection of courses, tutorials, and questions for the Open Energy Family
https://openenergyplatform.github.io/academy/
GNU Affero General Public License v3.0
16 stars 6 forks source link

CONTRIBUTING.md not up to date #217

Closed vismayajochem closed 2 months ago

vismayajochem commented 2 months ago

Description of the issue

There are multiple errors in the https://github.com/OpenEnergyPlatform/academy/blob/production/CONTRIBUTING.md

  1. At https://github.com/OpenEnergyPlatform/academy/blob/production/CONTRIBUTING.md there is under the section "Types of interaction" a link Contributor Covenant Code of Conduct. When clicking on that I get an "404 - page not found

Cannot find a valid ref in

main/CODE_OF_CONDUCT.md" error. I don't know if the file really doesn't exist or if the link is flawed.

  1. Under the topic "Types of interaction" point A. Use: I couldn't find an "USERS.cff" to add my name and personal details.

  2. Under the topic "Types of interaction" point B. Comment (Also at different places ind this document.): I couldn't find an "CITATION.cff" to add my name and personal details.

Steps to Reproduce

  1. Click on the link

Workflow checklist

christian-rli commented 2 months ago

Thank you for opening the issue. I added the previous authors in the citation.cff

christian-rli commented 2 months ago

There is no CODE_OF_CONDUCT.md so I removed the line. @Ludee might want to add the file at a later point and can reintroduce the line then.

christian-rli commented 2 months ago

@vismayajochem can you please reread the CONTRIBUTING.md with the applied changes and see if it makes sense to you now? If there are no further issues with this, you can close the issue.