Welcome to our GitHub space. All of Law&Orga's code is here. This document collects important information for the developers on this project. It contains rules that should be followed and material that is recommended for developing.
Here are some rules, that can not be enforced by code. These rules always apply unless stated otherwise within the rule.
- Every repository should start with
lawandorgain order to make the github search easier. - In the middle should be a meaningful name that describes the content of the repository, preferrably one word.
- In the end should be the type of the repository, this can be one of the following:
server,service,frontendorutils. If the type isserverthe repository should be able to create a whole server, if the name isserviceit should be a deployable app for example a docker container, if it isfrontendit should be deployable on a cdn andutilsshould be installable in other repositories. - If the repository is out of date ist should adhere to the other rules and add
obsoletein the end.
Those rules result in the following pattern:
lawandorga-[name]-[type]?(-obsolete)
Examples of repository names:
lawandorga-django-utils
lawandorga-chat-frontend
The thing to be named will be called object. Any object that needs a name, for example a database or a docker image, should have the same name as the repository that is the reason for this object's existence.
If some signs are not allowed or only a specific amount of letters is allowed the name should be changed in the following order until the name is allowed:
- Remove
-signs - Remove
lawandorga - Remove signs starting from the back
If the object only applies to a specific branch the branch should be added at the end. The branch should not be removed, steps 1 to 3 need to be done before the branch is added. If object is the backup of another object it should add backup in the and.
The following material is recommended to be understood, because the development tries to follow the principals discussed in those books or articles.