CorrelAid / correlaid_website

Source code for the CorrelAid website
https://correlaid.org
3 stars 0 forks source link

Improve Documentation for Collab #418

Closed LtSalt closed 4 months ago

LtSalt commented 10 months ago

As someone who has little to no experience collaborating with others, I would find it helpful to follow an internal wiki / documentation / guidelines.

In Correlaid's rlernen-planning-coding channel, we've talked about modifying and reusing this wiki within an internal meta ressources repo. I suggest going forward with it.

KonradUdoHannes commented 10 months ago

I agree for general guidelines and documentation. Any project specific information I would suggest to keep in the project README . My aspiration for an open source project README itself should give enough information such that in theory everybody can fork and contribute. This is probably not the case right now, but I would like to improve our README in that regard.

@LtSalt Do you have any project specific roadblocks that came up where you found the README lacking? It might even be that the information is there but it was not clear enough, after all the README did mostly grow organically so far and was never systematically restructured and starts to get a little large for not having a TOC.

KonradUdoHannes commented 10 months ago

Apparently I didn't realize that GitHub auto generates TOCs for about two years now 😂. Anyways I'll start making a "How to Contribute" section in the readme #426 and then coordinate what goes there and what goes into wiki etc. with this current issue.

LtSalt commented 10 months ago

I was missing information on the git workflow. There is a minimal description, but as someone who is just starting to collaborate with others, I'd want to make sure I am not wreaking havoc on the project and following best practices.

jstet commented 4 months ago

I will close this for now as collaboration is working at the moment