carpentries / governance

Information from the Executive Council
6 stars 10 forks source link

Add READMEs for directories #16

Closed k8hertweck closed 5 years ago

k8hertweck commented 5 years ago

Each subdirectory should include a README to explain the contents with more granularity than the main README

amyehodge commented 5 years ago

Agreed. They don't have to be much, but some explanation would be useful. For example, see the readme for the Transparency Reports folder.

k8hertweck commented 5 years ago

Definitely links to relevant information, but also some mention of process: for example, meeting minutes are for regularly occurring monthly meetings, CoC reports are quarterly, etc. Also points of contact for individuals to email/tag for more information.

amyehodge commented 5 years ago

Group, could someone volunteer to take on this task?

zjsteyn commented 5 years ago

Will take it on, @amyehodge proposed deadline?

amyehodge commented 5 years ago

@zjsteyn, by the meeting on August 15 would be great. Thanks for volunteering!

k8hertweck commented 5 years ago

I've added the two READMEs in question. These may need to be updated as we continue improving documentation, but this is sufficient for now.