Skip to content

Commit 7ed0563

Browse files
committed
Ignored formatting in blame, updated changelog, added contributin.md
1 parent 884ba42 commit 7ed0563

File tree

3 files changed

+20
-1
lines changed

3 files changed

+20
-1
lines changed

CHANGELOG

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ If not stated, FINUFFT is assumed (cuFINUFFT <=1.3 is listed separately).
1818
* MAX_NF increased from 1e11 to 1e12, since machines grow.
1919
* improved GPU python docs: migration guide; usage from cupy, numba, torch,
2020
pycuda. PyPI pkg still at 2.2.0beta.
21+
* Added a clang-format pre-commit hook to ensure consistent code style.
22+
Created a .clang-format file to define the style similar to the existing style.
23+
Applied clang-format to all cmake, C, C++, and CUDA code. Ignored the blame
24+
using .git-blame-ignore-revs. Added a contributing.md for developers.
2125

2226
V 2.2.0 (12/12/23)
2327

contributing.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
This repository is formatted according to the .clang-format in the root directory.
2+
Please enable the reformatting hook before committing your changes.
3+
See [pre-commit](https://pre-commit.com/) for more information.
4+
A quick summary:
5+
```
6+
pip install pre-commit
7+
pre-commit install
8+
```
9+
10+
We also suggest to configure your IDE to use the same formatting settings.
11+
12+
Another suggestion is to ignore the formatting commits in your git configuration:
13+
```
14+
git config blame.ignoreRevsFile .git-blame-ignore-revs
15+
```

docs/devnotes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Developer notes
44
===============
55

6-
* Developers needing to update/regenerate documentation in general, including our readthedocs website, see ``docs/README``. Developers changing MATLAB/octave interfaces or docs, also see ``matlab/README``.
6+
* Developers needing to update/regenerate documentation in general, including our readthedocs website, see ``docs/README``. Developers changing MATLAB/octave interfaces or docs, also see ``matlab/README``. Please also see ``contributing.md`` for code style and git hook guidelines.
77

88
* To update the version number, this needs to be done by hand in the following places:
99

0 commit comments

Comments
 (0)