From 4b301348a2dd035c6ad5df72f86eb99816488038 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexandre=20D=C3=A9fossez?= Date: Wed, 18 Sep 2024 13:22:14 +0200 Subject: [PATCH] template --- .github/PULL_REQUEST_TEMPLATE.md | 10 +++++++++- CONTRIBUTING.md | 3 ++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7d64535..52c082d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1 +1,9 @@ -Test hello youpi +## Checklist + +- [] Read CONTRIBUTING.md, and accept the CLA by including the provided snippet. We will not accept PR without this. +- [] Run pre-commit hook. +- [] If you changed Rust code, run `cargo check`, `cargo clippy`, `cargo test`. + +## PR Description + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e58e010..2621176 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,8 @@ However, we certainly welcome them for bug fixes. 1. Fork the repo and create your branch from `main`. 2. If you have changed APIs, update the documentation accordingly. 3. Ensure pre-commit hooks pass properly, in particular the linting and typing. -4. Accept the Contributor License Agreement (see after). +4. When changing the Rust code, run `cargo check`, `cargo clippy`, `cargo test`. +5. Accept the Contributor License Agreement (see after). Note that in general, we will not accept refactoring of the code.