Skip to content

Commit

Permalink
Minor change in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Fix grammar a bit, and remove example about splitting commits into
smaller chunks, since I don't want people to overdo it either.
  • Loading branch information
guillaumechereau committed Mar 20, 2024
1 parent e39b61b commit 1be67a2
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ For more information about that.

Try to follow the code style I used for Goxel, as I am unlikely to merge a pull
request that doesn't. The coding style is almost the one used by the linux
kernel, but using four spaces for indentation (I also accept typedef). When in
doubt, just look at other part of the code. The most important rules are:
kernel, but using four spaces for indentation, and I also accept typedef. When
in doubt, just look at other part of the code. The most important rules are:

- Use 4 spaces indentations. No tabs characters anywhere in the code.

Expand Down Expand Up @@ -94,7 +94,5 @@ doubt, just look at other part of the code. The most important rules are:
- The rest of the commit message separated by a blank line. Wrap lines at
72 characters.

- Try to separate the commits into small logical parts. For example if you
need to add a new public function in order to fix a bug, the first commit
should be about adding the function, and the second one about fixing the
bug.
- Try to separate the commits into smaller logical parts, so it is easier to
review them independently.

0 comments on commit 1be67a2

Please sign in to comment.