summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gnome.org>2021-10-17 00:02:39 +0100
committerEmmanuele Bassi <ebassi@gnome.org>2021-10-17 00:37:04 +0100
commit8bd7e1d45b07fb8089b09bc2206a8929357dec12 (patch)
tree533de92d7f7d23f64b1928844bc67f3bad08ed60 /CONTRIBUTING.md
parent86d24fff6cebfc34821a4c1cdd53f8a04b8d7dab (diff)
downloadlibgweather-8bd7e1d45b07fb8089b09bc2206a8929357dec12.tar.gz
docs: Mention clang-format
Contributors should use clang-format to ensure that their code fits in with the rest of the code base.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index fa7768d..44c6b64 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -132,6 +132,23 @@ Typically, you should work on your own branch:
$ git switch -C your-branch
```
+The coding style of libgweather is maintained through
+[clang-format](https://clang.llvm.org/docs/ClangFormat.html). The
+configuration is provided by libgweather itself. Before committing your
+changes, you should run:
+
+```sh
+clang-format \
+ --style=file \
+ libgweather/*.c \
+ libgweather/tests/*.c \
+ libgweather/tools/*.c
+```
+
+to ensure that the changes are formatted using the same coding style as the
+rest of the project. The project's own continuous integration pipeline will
+enforce the coding style.
+
Once you’ve finished working on the bug fix or feature, push the branch
to the Git repository and open a new merge request, to let the libgweather
core developers review your contribution.
@@ -264,6 +281,6 @@ There are a number of requirements for those tokens:
- One should be provided in the patch for testing purposes, and be easily
overridable by distributions wishing to have a separate identifier and limits
- The test token should have high enough limits that you're reasonably confident
- that lots of people running `make check` won’t cause the token to be revoked
+ that lots of people running `meson test` won’t cause the token to be revoked
and break everyone’s tests
- Instructions on how to get a token for the application must be provided