|
| 1 | + |
| 2 | +Thanks for contributing to CIEL. We hope it is useful to you and will |
| 3 | +be now more useful to everybody. |
| 4 | + |
| 5 | +Please follow these short guidelines. They'll help the maintainer(s) |
| 6 | +craft release notes and they make for a clearer commits log, *IMO*. Thank you! |
| 7 | + |
| 8 | +## Commit messages |
| 9 | + |
| 10 | +Please say at the beginning what your commit is changing: is it about |
| 11 | +dependencies? The Makefile, the .asd? The terminal/readline interface? |
| 12 | + |
| 13 | +` README:` for the README |
| 14 | +- `docs:` is for documentation |
| 15 | +- `deps:` for the Lisp dependencies (be more explicit for system-wide dependencies) |
| 16 | +- `CI:` |
| 17 | +- `asd:` |
| 18 | +- `terminal`: for the terminal REPL |
| 19 | + |
| 20 | +Example: |
| 21 | + |
| 22 | +> deps: libmagic-dev is no more required |
| 23 | +
|
| 24 | +If your change is about a domain, you can say it up front too. For example: |
| 25 | + |
| 26 | +> database: mention the need of db drivers for binaries |
| 27 | +
|
| 28 | +If your change is adding or removing something, you can say this action up front. |
| 29 | + |
| 30 | +If your change is wider or doesn't fit here, don't think harder, just contribute. Thanks. |
| 31 | + |
| 32 | + |
| 33 | +### Minor commit messages |
| 34 | + |
| 35 | +I like to see the `(minor)` mention when the change is really trivial |
| 36 | +and not worth looking at. Likewise, we can grep-it out from the |
| 37 | +release notes. |
| 38 | + |
| 39 | +For example: |
| 40 | + |
| 41 | +> (minor) add site icon |
| 42 | +
|
| 43 | +> (minor) make run typo |
| 44 | +
|
| 45 | +## Avoid small and useless commits, squash them |
| 46 | + |
| 47 | +Please avoid small commits that say "fix" "fix" and again |
| 48 | +"fix". Squash them into one with a good commit message (see above), |
| 49 | +thank you. |
0 commit comments