medic / cht-docs

Documentation site for the Community Health Tookit

https://docs.communityhealthtoolkit.org

14 stars 18 forks source link

chore: clarify pull request process #1500

Closed latin-panda closed 2 months ago

latin-panda commented 2 months ago

Description

clarity of including QA as reviewers
clarify the importance of documentation as part of the development process
Emphasis when a work is considered complete (ie, docs and test coverage are part of the process to completion).
suggests self-code reviews as best practices

License

The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.

latin-panda commented 2 months ago

@andrablaj @mrjones-plip, Can you give me your thoughts on this? These are not new practices; most have been going on for a while. The intention is to clarify points like (QA, best practices, etc.)

I'm leaving it as Draft because somehow my container gets stuck downloading Hugo's modules, so I'll verify the display later

latin-panda commented 2 months ago

It finally worked; this is the video of the docs in case it's easier to visualize the format.

https://github.com/user-attachments/assets/fc7ab448-e0ea-469d-a6d5-0b3394b894f0

latin-panda commented 2 months ago

I agree this page needs to be restructured. In a separate PR next week?

mrjones-plip commented 2 months ago

I think @andrablaj is doing a great job here! pulling myself off reviewers list, but lemme know if you want me back for any reason!

latin-panda commented 2 months ago

@andrablaj Thanks for all the thoughtful suggestions! 🤩 It's looking a lot better now

https://github.com/user-attachments/assets/430172aa-e3c8-498c-bfc5-1f9a6084dc4e

latin-panda commented 2 months ago

@andrablaj I submitted the latest feedback, please have a look! Thanks!