summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Beyer <matthias.beyer@ifm.com>2022-08-31 11:08:52 +0200
committerMatthias Beyer <matthias.beyer@ifm.com>2022-09-01 17:46:58 +0200
commita936523c2b575b66368c44f6c3499f0705cbe869 (patch)
treea8b0350deed6081fa4f402a8e8a014b5270019cd
parent1dec0d32c08b43f846cfb9c3fdf2817ddc7d0288 (diff)
Move section on coding style, doc and testing
In de3bcc7e16b69d753b132ebbbb4da8073cf18b74 ("Move "Repository maintenance" section to CONTRIBUTING.md") we moved the "Repository maintenance" section to the CONTRIBUTING.md file. This patch moves the sections on coding style, documentation and testing and merges them into one section (because there isn't enough text to make them individual sections). Fixes: de3bcc7e16b69d753b132ebbbb4da8073cf18b74 ("Move "Repository maintenance" section to CONTRIBUTING.md") Signed-off-by: Matthias Beyer <matthias.beyer@ifm.com>
-rw-r--r--CONTRIBUTING.md36
1 files changed, 19 insertions, 17 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 62c9a9ca..ef7d614c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -99,6 +99,25 @@ request misses the `Signed-off-by` trailer.
As a result, it is not possible to merge pull requests that miss the trailer.
+## Coding style, Documentation, Testing
+
+Coding style is enforced via `rustfmt` in its default configuration.
+Compliance with the coding style is enforced via CI.
+
+Source code documentation as well as other documentation is tested via github
+actions workflows as well, to ensure that a developer is able to build all
+relevant documentation on their local machine.
+
+Testing is done via workflows in github actions using `cargo test --all-features` for all
+crates.
+The main objective with this is that a developer should be able to simply run
+`cargo test` on their local machine to be able to see whether CI would succeed
+for changes they submit in a pull request.
+Thus, all CI tests (unit tests, but also integration tests) are implemented in
+Rust and do not rely on external services.
+End-to-end system tests - that depend on external services - are run outside the CI pipeline,
+to avoid inconsistent test outcomes because of external issues.
+
## Reviewing, addressing feedback, and merging
Generally, pull requests need at least an approval from one maintainer to be
@@ -204,24 +223,7 @@ See [setting your commit email address in Git](https://docs.github.com/en/github
## Repository maintenance
-- **Coding styleguide**
- Coding style is enforced via `rustfmt` in its default configuration.
- Compliance with the coding style is enforced via CI.
-- **Testing**
- Testing is done via workflows in github actions using `cargo test --all-features` for all
- crates.
- The main objective with this is that a developer should be able to simply run
- `cargo test` on their local machine to be able to see whether CI would succeed
- for changes they submit in a pull request.
- Thus, all CI tests (unit tests, but also integration tests) are implemented in
- Rust and do not rely on external services.
- End-to-end system tests - that depend on external services - are run outside the CI pipeline,
- to avoid inconsistent test outcomes because of external issues.
- **Benchmarks**
-- **Documentation builds**
- Source code documentation as well as other documentation is tested via github
- actions workflows as well, to ensure that a developer is able to build all
- relevant documentation on their local machine.
- **Keeping spec up to date**
- **Evergreen master**
The project pursues the "evergreen master" strategy. That means that at every