Commit Graph

4 Commits

Author SHA1 Message Date
Jehan dc36b45f88 CODING_STYLE: update.
- Organize the rules in sections and subsections.
- Add some text about the linear git history (this can be seen as coding
  style after all).
- Add comment coding style and non-public API documentation sections.
- A bit of section reordering.
- Move the configuration files info from HACKING into CODING_STYLE.md,
  and make a new "Helping tools" section.
2021-10-31 01:31:47 +02:00
Jehan 46e00a11c9 CODING_STYLE: update intro and use [TOC] markdown macro.
- Improve a bit the intro by adding a link to GNU's coding style. Also
  coding style is not a matter of taste, this is the whole point which
  is that once specified, it doesn't matter anymore if we prefer one
  style or another.
- Replace the table of content with [TOC] macro. No need to maintain
  this manually (it will only break with time).
- "Line width" section was wrongly indented.
2021-10-30 20:16:22 +02:00
Jehan 5ed68ab45b CODING_STYLE: add a "Commit messages" section.
Because it is important to have good commit messages for future
investigations of code.
2021-10-20 12:51:31 +02:00
Stanislav Grinkov 1373bec64a Add separate CODING_STYLE file 2021-08-02 11:16:34 +00:00