Bug 31650

Summary: We should publish our coding guidelines more openly
Product: Project Infrastructure Reporter: Martin Renvoize (ashimema) <martin.renvoize>
Component: Project websiteAssignee: Liz Rea <wizzyrea>
Status: NEW --- QA Contact:
Severity: enhancement    
Priority: P5 - low CC: dcook, julian.maurice, wizzyrea
Version: unspecified   
Hardware: All   
OS: All   
GIT URL: Change sponsored?: ---
Patch complexity: --- Documentation contact:
Documentation submission: Text to go in the release notes:
Version(s) released in:
Circulation function:

Description Martin Renvoize (ashimema) 2022-09-29 08:07:48 UTC
Our coding guidelines are currently hidden deep in th wiki.. to encourage more reference to them, we could publish them more openly as their own mini-site linked directly from the website.. more akin to our manual and API docs sites.
Comment 1 Julian Maurice 2022-09-29 08:18:44 UTC
Just an idea: we could move them inside the git repository. That would bring them closer to where they are needed, they can be published using a link to git.koha-community.org, and changes can be proposed using the current patch workflow.
Comment 2 Liz Rea 2023-05-04 13:58:11 UTC
Why don't we put this in the website somewhere?
Comment 3 David Cook 2023-05-04 23:40:48 UTC
(In reply to Julian Maurice from comment #1)
> Just an idea: we could move them inside the git repository. That would bring
> them closer to where they are needed, they can be published using a link to
> git.koha-community.org, and changes can be proposed using the current patch
> workflow.

I was just thinking how a lot of projects have a CONTRIBUTING.md file for this in their git repos. 

https://github.com/github/docs/blob/main/CONTRIBUTING.md

https://github.com/rails/rails/blob/main/CONTRIBUTING.md

https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors