Skip to content

Commit d6bfa68

Browse files
Adding contribution file
Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
1 parent ec92a9c commit d6bfa68

1 file changed

Lines changed: 49 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# CONTRIBUTING
2+
3+
Contributions are very welcome. When contributing code, please follow these
4+
simple guidelines.
5+
6+
* Make happy Github actions.
7+
* Write properly formatted git commits (see below).
8+
* If you don't know where to start, look to the good first issue, or [open a discussion](https://github.com/clightning4j/JRPClightning/discussions)
9+
10+
Git commits
11+
-----------
12+
A properly formed git commit subject line should always be able to complete the
13+
following sentence:
14+
15+
If applied, this commit will _____
16+
17+
For example, the following message is well formed:
18+
19+
Add support for .gif files
20+
21+
In addition, it should be capitalized and *must not* include a period.
22+
23+
When it comes to formatting, here's a model git commit message[1]:
24+
25+
Capitalized, short (50 chars or less) summary
26+
27+
More detailed explanatory text, if necessary. Wrap it to about 72
28+
characters or so. In some contexts, the first line is treated as the
29+
subject of an email and the rest of the text as the body. The blank
30+
line separating the summary from the body is critical (unless you omit
31+
the body entirely); tools like rebase can get confused if you run the
32+
two together.
33+
34+
Write your commit message in the imperative: "Fix bug" and not "Fixed bug"
35+
or "Fixes bug." This convention matches up with commit messages generated
36+
by commands like git merge and git revert.
37+
38+
Further paragraphs come after blank lines.
39+
40+
- Bullet points are okay, too.
41+
42+
- Typically a hyphen or asterisk is used for the bullet, followed by a
43+
single space, with blank lines in between, but conventions vary here.
44+
45+
- Use a hanging indent.
46+
47+
---
48+
49+
[1]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

0 commit comments

Comments
 (0)