Skip to content

Commit 757d0f2

Browse files
author
Dennis Labordus
committed
Updating and adding pages.
Signed-off-by: Dennis Labordus <[email protected]>
1 parent a145300 commit 757d0f2

File tree

2 files changed

+27
-26
lines changed

2 files changed

+27
-26
lines changed

docs/GOVERNANCE.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
* [Project Owner](#project-owner)
66
* [Technical Charter](#technical-charter)
77
* [Committers](#committers)
8+
* [Responsibilities](#responsibilities)
89
* [Technical Steering Committee](#technical-steering-committee)
910
* [Contributors](#contributors)
1011

@@ -25,12 +26,25 @@ write code directly to the repository and screen the contributions of others. In
2526
but it is also possible that they contribute in a different role. Typically, a committer will focus on a specific aspect
2627
of the project, and will bring a level of expertise and understanding that earns them the respect of the community and the project owner.
2728

29+
## Responsibilities
30+
31+
The project is split into several repositories. There is at least one Committer in charge of each repository.
32+
By "in charge", we mean:
33+
- best effort to review the pull request,
34+
- best effort to resolve issues,
35+
- building and publishing the releases, including writing the release notes and informing the community,
36+
- in case of inability to perform the above tasks, the Committer in charge has to ask the TSC through the list
37+
[[email protected]](mailto:[email protected]) to find another Committer to review the pull request,
38+
resolve the issue or build and publish the release.
39+
40+
Please refer to our [commiters file](https://github.com/com-pas/contributing/blob/master/COMMITERS.md) for more details about our work division.
41+
2842
## Technical Steering Committee
2943

3044
The Technical Steering Committee (TSC) is composed of voting members elected by the active Committers as described in the
3145
project’s Technical Charter. The TSC is responsible for the technical direction of the project.
3246

33-
## Members
47+
### Members
3448

3549
CoMPAS TSC voting members are:
3650
- Norbert Armand (https://github.com/Norbert-armand)
@@ -40,25 +54,12 @@ CoMPAS TSC voting members are:
4054
- Sander Jansen (https://github.com/Sander3003)
4155
- Rob Tjalma (https://github.com/Flurb)
4256

43-
## Voting
57+
### Voting
4458

4559
While the Project aims to operate as a consensus-based community, if any TSC decision requires a vote to move the Project
4660
forward, the voting members of the TSC will vote on a one vote per voting member basis. The simple majority is needed to approve proposals.
4761
The preferred way to vote is to create a poll [here](https://lists.lfenergy.org/g/CoMPAS-tsc/addpoll).
4862

49-
## Responsibilities
50-
51-
The project is split into several repositories. There is at least one Committer in charge of each repository.
52-
By "in charge", we mean:
53-
- best effort to review the pull request,
54-
- best effort to resolve issues,
55-
- building and publishing the releases, including writing the release notes and informing the community,
56-
- in case of inability to perform the above tasks, the Committer in charge has to ask the TSC through the list
57-
[[email protected]](mailto:[email protected]) to find another Committer to review the pull request,
58-
resolve the issue or build and publish the release.
59-
60-
Please refer to our [commiters file](https://github.com/com-pas/contributing/blob/master/COMMITERS.md) for more details about our work division.
61-
6263
## Contributors
6364

6465
Contributors include anyone in the technical community that contributes code, documentation, or other technical artifacts to the Project.

docs/STYLEGUIDE.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,16 @@
22

33
#### Table Of Contents
44

5+
* [English language convention](#english-language-convention)
56
* [Copyright Guidelines](#copyright-guidelines)
6-
* [Git Commit Messages](#git-commit-messages)
77
* [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.
915

1016
## Copyright Guidelines
1117

@@ -27,11 +33,6 @@ Every commit on a Pull Request is being scanned by REUSE. If it fails, the pull
2733
For more tips on using REUSE (for example with a small command line tool), check the
2834
[Tips: Copyright & Licensing](https://wiki.lfenergy.org/pages/viewpage.action?pageId=10996220) wiki page.
2935

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-
3536
## Java StyleGuide
3637

3738
- 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 ...
4647
*/
4748
```
4849

49-
## English language convention
50+
## Git Commit Messages
5051

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

Comments
 (0)