search

open-zaak / open-zaak

Open Zaak is a modern, open-source data- and services-layer to enable zaakgericht werken, a Dutch approach to case management.
Other
39 stars 37 forks source link

As developer, I want to know what guidelines the code should adhere to #27

Open joeribekker opened 5 years ago

joeribekker commented 5 years ago

... so I can conform myself to these guidelines.

Description As discussed with municipalities, we might need to have some external code guidelines to make this a proper community project.

A suggestion was to use: https://standard.publiccode.net/criteria/bundle-policy-and-code.html

Note that these "meta" tasks will influence development speed. However, the longer we wait to decide what to do, the harder it gets.

Hugo-ter-Doest commented 5 years ago

I prefer to adopt BOMOS https://www.forumstandaardisatie.nl/sites/bfs/files/proceedings/FS22-10-04%204b%20BOMOS.pdf because that is a government policy for open source. That probably means that we have to extract some principles from that document. I find the publiccode abstract, and it has a strange orientation towards workflow for documenting a policy (why?).

joeribekker commented 4 years ago

This task is so generic that I wonder if we should do it. But then again, so is everyone else I guess which leads to nowhere...

joeribekker commented 4 years ago

An initial version will be added via #20 that just concerns itself with proper code formatting and how to make a PR.

This issue can be used to refine and/or extend on it.

sergei-maertens commented 3 years ago

@ericherman maybe you can provide some insight here, but in my opinion https://open-zaak.readthedocs.io/en/stable/development/principles.html should be sufficient, no?

We have automated black, isort and flake8 checks in CI for the linting.