Skip to content

Commit a145300

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

File tree

5 files changed

+89
-58
lines changed

5 files changed

+89
-58
lines changed

docs/DEVELOPING.md

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
#### Table Of Contents
44

55
* [Tooling](#tooling)
6-
* [Styleguides](#styleguides)
76
* [IDEs](#ides)
87
* [GitHub Actions](#github-actions)
98
* [Others](#others)
@@ -44,7 +43,7 @@ The project uses Maven to manage the build. Most projects use multi-module struc
4443
$ maven clean verify
4544
```
4645

47-
### GitHub Packages in Maven
46+
#### GitHub Packages in Maven
4847
To use GitHub Packages in Maven an extra repository need to be added to the build process.
4948
```xml
5049
<repositories>
@@ -57,7 +56,7 @@ To use GitHub Packages in Maven an extra repository need to be added to the buil
5756
```
5857
Because credentials are needed for GitHub Packages, these will be passed by using the Settings.xml file.
5958

60-
### Maven Local Settings.xml for GitHub Packages
59+
#### Maven Local Settings.xml for GitHub Packages
6160
Edit (or create if not already exists) the `~/.m2/settings.xml` file and add the following content:
6261
```xml
6362
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
@@ -80,26 +79,6 @@ Add this server section. The ID of the server must be the same as the ID found i
8079
Username should be your GitHub username, password can both be your own [encrypted password](https://maven.apache.org/guides/mini/guide-encryption.html)
8180
or a [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token).
8281

83-
## Styleguides
84-
85-
### Git Commit Messages
86-
87-
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. 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.
88-
89-
### Java StyleGuide
90-
91-
- The project uses modern java, feel free to use any new APIs provided by the current java version (currently java 8).
92-
- New API classes and methods should be documented with javadoc. Write higher level documentation for classes and lower level documentation for methods. For example, ...
93-
- User-facing configuration options and general design decisions should be documented (where?)
94-
- We use standard configurations of well known tools like checkstyle and sonarqube to enforce a coherent coding style, please consult those tools for justifications on these rules.
95-
96-
As a simple yet instructive example, consider ...
97-
```java
98-
/**
99-
* Example?
100-
*/
101-
```
102-
10382
## IDEs
10483
If your IDE is supported by sonarlint (both IntelliJ IDEA and the Eclipse IDE are supported), it is recommended to install it.
10584
It provides immediate feedback on most sonar issues. Running tests individually is often possible in IDEs without invoking maven.

docs/GOVERNANCE.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,25 @@
1010

1111
## Project Owner
1212

13-
CoMPAS is part of the [LF Energy Foundation](https://www.lfenergy.org/), a project of The Linux Foundation that supports open source innovation projects within the energy and electricity sectors.
13+
CoMPAS is part of the [LF Energy Foundation](https://www.lfenergy.org/), a project of The Linux Foundation that supports
14+
open source innovation projects within the energy and electricity sectors.
1415

1516
## Technical Charter
1617

17-
The Project's [Technical Charter](blob-files/CoMPAS_Technical_Charter_2020-06-07.pdf) sets forth the responsibilities and procedures for technical contribution to, and oversight of, the COMPAS Project.
18+
The Project's [Technical Charter](blob-files/CoMPAS_Technical_Charter_2020-06-07.pdf) sets forth the responsibilities and
19+
procedures for technical contribution to, and oversight of, the COMPAS Project.
1820

1921
## Committers
2022

21-
Committers are contributors who have made several valuable contributions to the project and are now relied upon to both write code directly to the repository and screen the contributions of others. In many cases they are programmers but it is also possible that they contribute in a different role. Typically, a committer will focus on a specific aspect of the project, and will bring a level of expertise and understanding that earns them the respect of the community and the project owner.
23+
Committers are contributors who have made several valuable contributions to the project and are now relied upon to both
24+
write code directly to the repository and screen the contributions of others. In many cases they are programmers,
25+
but it is also possible that they contribute in a different role. Typically, a committer will focus on a specific aspect
26+
of the project, and will bring a level of expertise and understanding that earns them the respect of the community and the project owner.
2227

2328
## Technical Steering Committee
2429

25-
The Technical Steering Committee (TSC) is composed of voting members elected by the active Committers as described in the project’s Technical Charter. The TSC is responsible for the technical direction of the project.
30+
The Technical Steering Committee (TSC) is composed of voting members elected by the active Committers as described in the
31+
project’s Technical Charter. The TSC is responsible for the technical direction of the project.
2632

2733
## Members
2834

@@ -36,21 +42,26 @@ CoMPAS TSC voting members are:
3642

3743
## Voting
3844

39-
While the Project aims to operate as a consensus-based community, if any TSC decision requires a vote to move the Project 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.
45+
While the Project aims to operate as a consensus-based community, if any TSC decision requires a vote to move the Project
46+
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.
4047
The preferred way to vote is to create a poll [here](https://lists.lfenergy.org/g/CoMPAS-tsc/addpoll).
4148

4249
## Responsibilities
4350

44-
The project is split into several repositories. There is at least one Committer in charge of each repository. By "in charge", we mean:
45-
- best effort to review the pull request,
46-
- best effort to resolve issues,
47-
- building and publishing the releases, including writing the release notes and informing the community,
48-
- in case of unability to perform the above tasks, the Committer in charge has to ask the TSC through the list [[email protected]](mailto:[email protected]) to find another Committer to review the pull request, resolve the issue or build and publish the release.
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.
4959

50-
Please refer to our [maintainers file](MAINTAINERS.md) for more details about our work division.
60+
Please refer to our [commiters file](https://github.com/com-pas/contributing/blob/master/COMMITERS.md) for more details about our work division.
5161

5262
## Contributors
5363

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

56-
Anyone can become a contributor. There is no expectation of commitment to the project, no specific skill requirements and no selection process. To become a contributor, a community member simply has to perform one or more actions that are beneficial to the project.
66+
Anyone can become a contributor. There is no expectation of commitment to the project, no specific skill requirements and no selection process.
67+
To become a contributor, a community member simply has to perform one or more actions that are beneficial to the project.

0 commit comments

Comments
 (0)