Skip to content

Commit

Permalink
Merge pull request IBAMR#1699 from drwells/more-clang-format-docs
Browse files Browse the repository at this point in the history
Add some more documentation on clang-format.
  • Loading branch information
amneetb authored Apr 4, 2024
2 parents 1cdddd6 + dc3c24a commit a6bdb29
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------

Expand Down
3 changes: 2 additions & 1 deletion doc/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a6bdb29

Please sign in to comment.