Make `CONTRIBUTING.md` less frightening

OpenEnergyPlatform / open-MaStR

A collaborative software to download the energy database Marktstammdatenregister (MaStR)

https://open-mastr.readthedocs.io/en/latest/

GNU Affero General Public License v3.0

83 stars 17 forks source link

Make `CONTRIBUTING.md` less frightening #535

Closed FlorianK13 closed 2 months ago

FlorianK13 commented 2 months ago

I think our CONTRIBUTING.md can scare people, especially new people who have not contributed to Open Source Software before. Maybe we can add a short sentence at the beginning, encouraging people to do as good as they can but that it is not a bad thing if they forget one of the steps there and that we are happy to help.

What do you think @chrwm @nesnoj

nesnoj commented 2 months ago

Yes, good point! I once found this "imposter syndrome disclaimer" which I think is very inviting and a good approach: https://github.com/adriennefriend/imposter-syndrome-disclaimer There are multiple projects linked which have very nice modified versions.

What do think?

FlorianK13 commented 2 months ago

Looks good. This would then replace https://github.com/OpenEnergyPlatform/open-MaStR?tab=readme-ov-file#collaboration I guess? Or even better at the beginning of CONTRIBUTING, similar to here.