mirrors/monado
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/monado/monado.git synced 2025-01-29 18:08:29 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: Add some text to "conventions" about coding with respect

Browse source
This commit is contained in:
Ryan Pavlik 2022-05-17 17:11:32 -05:00
parent 4fb62a8d8f
commit b72de59c8d
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/conventions.md
View file

@ -16,6 +16,18 @@ mentioned in these examples.
Here are some general code style guidelines we follow.
Note that we aim to "code with respect", to avoid terminology that may limit our
community or hurt those in it, as well as to conform with emerging industry
standards. Good guidelines to look to include the
[Android Coding with Respect][] policy and the
[Write Inclusive Documentation][] page from the Google developer documentation
style guide. The latter also links to a word list for clear documentation,
which, while not binding on this project, is useful in making sure your code,
comments, and docs are understandable by the worldwide Monado community.
[Android Coding with Respect]: https://source.android.com/setup/contribute/respectful-code
[Write Inclusive Documentation]: https://developers.google.com/style/inclusive-documentation
## APIs
Internal APIs, when it makes sense, should be C APIs. Headers that define