The open source OpenXR runtime
doc: Add some text to "conventions" about coding with respect
+12
+12
doc/conventions.md
+12
doc/conventions.md
···
16
16
17
17
Here are some general code style guidelines we follow.
18
18
19
+
Note that we aim to "code with respect", to avoid terminology that may limit our
20
+
community or hurt those in it, as well as to conform with emerging industry
21
+
standards. Good guidelines to look to include the
22
+
[Android Coding with Respect][] policy and the
23
+
[Write Inclusive Documentation][] page from the Google developer documentation
24
+
style guide. The latter also links to a word list for clear documentation,
25
+
which, while not binding on this project, is useful in making sure your code,
26
+
comments, and docs are understandable by the worldwide Monado community.
27
+
28
+
[Android Coding with Respect]: https://source.android.com/setup/contribute/respectful-code
29
+
[Write Inclusive Documentation]: https://developers.google.com/style/inclusive-documentation
30
+
19
31
## APIs
20
32
21
33
Internal APIs, when it makes sense, should be C APIs. Headers that define