Contributing guide#1565
Conversation
Just for the record I would like to clarify: There has been a contributor guide in this repo since 2018. This PR updates the guide. |
|
Question: Is this repo the best place for these documents? Should they apply to plugins as well? Would a central place, like the docs, make more sense? |
|
@afuetterer yes, My idea was that this repo is actually the place where people would look. I expect that We follow KITODO here: https://github.com/UB-Mannheim/kitodo-coding-guidelines. |
|
I implemented all requested changes (I think ...), added a
I hope that is ok for everybody. |
|
Still found one typo in |
|
I added a note to the document and I think we can merge now. I talked to various people and I am now pretty convinced that we should add the documents to the main |
This PR adds/updates 5 documents to the repo:
CONTRIBUTING.mdcontains the guidelines for contributors how we work.ARCHITECTURE.mdaims to explain the structure of the repository, file naming conventions and external and internal dependencies.STYLE.mdcollects naming conventions, code patterns and ux/ui considerations.CODE_OF_CONDUCT.mdour code of conduct.SECURITY.md.I will present the documents at the community meeting and we will have a review process with the community. While afterwards
CONTRIBUTING.mdis meant to be more or less stable, I expect the other two documents to be updated more frequently.Direct links for convenience: