This repository contains documentation for contributors to the Zetkin project. In here you will find information about the architecture, how to get started with contributing, style guides for the various programming languages used in the Zetkin modules, et c.
You should be reading this if you are planning on contributing to any part of the Zetkin ecosystem. This repository contains information that is common to all or at least several of the many different modules that Zetkin consists of. In addition to this information, modules may have contributor documentation that is specific to the respective module. You will find such information in the repository that contains the module code.
Zetkin is a platform for organizing activism. It is developed and maintained by the Zetkin Foundation. You can find more information about Zetkin on the Zetkin Foundation website.
All documentation in this repository is in Markdown format. You can read it in plain text or formatted by the GitHub interface, or any other compatible viewer.
The documentation is organized in folders by topic.
/style: This folder contains style guides for languages used in the Zetkin project, organized in sub-folders by language file extension.
Although all modules of the Zetkin project must follow the rules set forth in this documentation, these documents themselves, like anything in an open-source project, is open for debate.
If you find something that you believe is incorrect, or if you have another opinion about best practices than one found in this documentation, you should submit a pull request to this repository and argue why the documentation (and hence the rules and guides therein) should be changed.
If you find a piece of code that you believe do not follow the style described in this documentation, submit a pull request to the repository containing the incorrect code, or file an issue report for that repository, referencing the part of the Contributors Reference that it violates.