From dc3c24af36882a7ca5f505abb31619760da53c63 Mon Sep 17 00:00:00 2001 From: David Wells Date: Mon, 1 Apr 2024 12:29:00 -0400 Subject: [PATCH] Add some more documentation on clang-format. This makes things a little clearer. One thing we need to manually do now is make sure that all the outstanding PR authors are aware that they will need to run `make indent` since updating the checklist on `master` does not update it in their PRs. --- README.md | 8 ++++++++ doc/pull_request_template.md | 3 ++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d424a31587..c3bff32328 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,14 @@ Bugs and Other Issues Please use the GitHub issue tracking system to report bugs, feature requests, or other issues with IBAMR. +Writing patches +--------------- + +IBAMR has a core group of developers but also regularly takes contributions from our students as well as outside users. +All patches undergo a peer review process and are usually accepted after some minor revisions. +To ensure style uniformity, we require that users run `make indent` (or make the fixes indicated by the continous integration run). +For more information on how this process works see `scripts/formatting/README.md`. + Acknowledgments --------------- diff --git a/doc/pull_request_template.md b/doc/pull_request_template.md index 8125eb4c2d..5fa4300ced 100644 --- a/doc/pull_request_template.md +++ b/doc/pull_request_template.md @@ -9,7 +9,8 @@ code. Thanks in advance for helping to make IBAMR better! ### IBAMR Pull Request Checklist - [ ] Does the test suite pass? -- [ ] Was clang-format (i.e., `make indent`) run? +- [ ] Was clang-format (i.e., `make indent`) run? For more information see + `scripts/formatting/README.md`. - [ ] Were relevant issues cited? Please remember to add `Fixes #12345` to close the issue automatically if we are fixing the problem. - [ ] Is this a change others will want to know about? If so, then has a