-
Notifications
You must be signed in to change notification settings - Fork 1
Contributing to AquariWM
One of the fundamental purposes of AquariWM is to provide for the community and to create a window manager accessible, usable, welcoming and useful to as many people as it can. What better way to achieve this goal than for AquariWM to be developed by the community too? Any contribution, big or small, is appreciated tremendously.
While this contributor's wiki is not yet complete, there is still some important information to keep in mind when contributing to AquariWM:
- Make sure all contributions include and don't modify or remove the appropriate license headers wherever possible. AquariWM uses the Mozilla Public License v2.0, and license header snippets and further information can be found, for now, in the existing contributor's document.
- Use hard tab characters instead of spaces for indentation unless it is impossible to do so (e.g. for YAML files). More information can be found in the pinned discussion in the Discussions tab.
- Keep line lengths in all files to 99 characters or less if possible. Only if you must not break up a line of text 100 characters or more in width should this limit ne exceeded.
- Keep the line lengths of comments to 80 cnaracters or less.
- Prefer to keep lines around 80 characters in width.
- Follow any other code style guidelines of the languages involved in your contributions, unless they conflict with the previously mentioned rules, as those previously mentioned rules take precedence.
Information about the design of AquariWM's features and code will be added in the future, as well as additional explanation of other guidelines, processes and recommendations relevant to contributors.
Please remember, above all else, to always remain respectful, patient, friendly and helpful when interacting with other members of the AquariWM community, including other contributors. Discrimination including racism, homophobia, transphobia, ableism, as well as any other forms of discrimination, hate speech or slurs are forbidden in the AquariWM community and will be taken extremely seriously. Stay kind!