forked from libconfuse/libconfuse
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix issue libconfuse#33: Reindent to Linux coding style
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
- Loading branch information
Showing
24 changed files
with
2,902 additions
and
3,036 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
Contributing to libConfuse | ||
========================== | ||
|
||
We welcome any and all help in the form of bug reports, fixes, patches | ||
for new features -- *preferably as [GitHub][github] pull requests* -- | ||
submitting a pull request practically guarantees inclusion ... | ||
|
||
|
||
Coding Style | ||
------------ | ||
|
||
First of all, lines are allowed to be longer than 72 characters these | ||
days. In fact, there exist no enforced maximum, but keeping it around | ||
100/132 characters is OK. | ||
|
||
The coding style in libConfuse is Linux [KNF][], detailed [here][style]. | ||
To aid developers contributing to the project, source files contain a | ||
trailer of `Local Variables:` used to instruct Emacs to use the correct | ||
indentation mode. There is also a silly little script `indent.sh`, | ||
which is only supposed to serve as a help. | ||
|
||
> Always submit code that follows the style of surrounding code! | ||
|
||
Commit Messages | ||
--------------- | ||
|
||
Commit messages exist to track *why* a change was made. Try to be as | ||
clear and concise as possible in your commit messages. Example from | ||
the [Pro Git][gitbook] online book: | ||
|
||
Brief, but clear and concise summary of changes | ||
|
||
More detailed explanatory text, if necessary. Wrap it to about 72 | ||
characters or so. In some contexts, the first line is treated as | ||
the subject of an email and the rest of the text as the body. The | ||
blank line separating the ummary from the body is critical (unless | ||
you omit the body entirely); tools like rebase can get confused if | ||
you run the two together. | ||
|
||
Further paragraphs come after blank lines. | ||
|
||
- Bullet points are okay, too | ||
|
||
- Typically a hyphen or asterisk is used for the bullet, preceded | ||
by a single space, with blank lines in between, but conventions | ||
vary here | ||
|
||
Signed-off-by: First Lastname <some.email@example.com> | ||
|
||
|
||
A good *counter* example [is this][rambling] ... | ||
|
||
|
||
Code of Conduct | ||
--------------- | ||
|
||
It is expected of everyone engaging in the project to, in the words of | ||
Bill & Ted; be excellent to each other. | ||
|
||
|
||
[github]: https://github.com/martinh/libconfuse/ | ||
[KNF]: https://en.wikipedia.org/wiki/Kernel_Normal_Form | ||
[style]: https://www.kernel.org/doc/Documentation/CodingStyle | ||
[gitbook]: https://git-scm.com/book/ch5-2.html | ||
[rambling]: http://stopwritingramblingcommitmessages.com/ | ||
|
||
<!-- | ||
-- Local Variables: | ||
-- mode: markdown | ||
-- End: | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.