You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/STYLEGUIDE.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,10 +2,16 @@
2
2
3
3
#### Table Of Contents
4
4
5
+
*[English language convention](#english-language-convention)
5
6
*[Copyright Guidelines](#copyright-guidelines)
6
-
*[Git Commit Messages](#git-commit-messages)
7
7
*[Java StyleGuide](#java-styleGuide)
8
-
*[English language convention](#english-language-convention)
8
+
*[Git Commit Messages](#git-commit-messages)
9
+
10
+
## English language convention
11
+
12
+
The convention for all the project's documents, including code documentation, website, is to write American English.
13
+
A list of spelling differences between British and American English is available
14
+
[here](https://www.britishcouncilfoundation.id/en/english/articles/british-and-american-english) for example.
9
15
10
16
## Copyright Guidelines
11
17
@@ -27,11 +33,6 @@ Every commit on a Pull Request is being scanned by REUSE. If it fails, the pull
27
33
For more tips on using REUSE (for example with a small command line tool), check the
28
34
[Tips: Copyright & Licensing](https://wiki.lfenergy.org/pages/viewpage.action?pageId=10996220) wiki page.
29
35
30
-
## Git Commit Messages
31
-
32
-
As usual, please start the commit message with a short line describing the commit, then leave a blank line, then give more context and explanations.
33
-
You can use GitHub's integrations, for exemple to link to existing issues. In general, pull requests with more than one commits will be squashed when merged in master.
34
-
35
36
## Java StyleGuide
36
37
37
38
- The project uses modern java, feel free to use any new APIs provided by the current java version (currently java 11).
@@ -46,8 +47,7 @@ As a simple yet instructive example, consider ...
46
47
*/
47
48
```
48
49
49
-
## English language convention
50
+
## Git Commit Messages
50
51
51
-
The convention for all the project's documents, including code documentation, website, is to write American English.
52
-
A list of spelling differences between British and American English is available
53
-
[here](https://www.britishcouncilfoundation.id/en/english/articles/british-and-american-english) for example.
52
+
As usual, please start the commit message with a short line describing the commit, then leave a blank line, then give more context and explanations.
53
+
You can use GitHub's integrations, for exemple to link to existing issues. In general, pull requests with more than one commits will be squashed when merged in master.
0 commit comments