Skip to content

Commit 8769812

Browse files
author
Rob Tjalma
committed
Added full how-to begin
Signed-off-by: Rob Tjalma <[email protected]>
1 parent f1da14d commit 8769812

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -153,15 +153,18 @@ Copyright and license information is done on per-file basis. We use the specific
153153

154154
Every source code repository within CoMPAS has a Github Action for checking against the REUSE specification.
155155

156-
For more information, check
157-
158-
Something about build tools
159-
Something about IDEs
160-
Something about documenting
161-
Something about licences (LFX Security Tool)
162-
Something about LFX Security tool
163-
Something about Github Actions
164-
Something about used technologies / architecture
156+
For more information, check the [Copyright Guidelines](#copyright-guidelines) section.
157+
158+
#### LFX Security Tool
159+
For checking potential security issues, we use the [LFX Security Tool](https://security.lfx.linuxfoundation.org/#/e8b6fdf9-2686-44c5-bbaa-6965d04ad3e1/licenses). The LFX Security Tool scans selected repositories for potential security issues in dependencies. It also scans every license that is being used within a repository and checks if they are compatible within open source projects.
160+
161+
#### SonarCloud
162+
CoMPAS is using [SonarCloud](https://sonarcloud.io/organizations/com-pas/projects) for static code analysis. Every Github repository has a Github Action which automatically pushes the code to SonarCloud with a frequency of the given Github Action (most of the time on each push).
163+
164+
A Pull Request can't be merged before all SonarCloud issues are being fixed!
165+
166+
#### Architecture and technologies
167+
For all architecture and technology choices (for example frameworks, build tools, database choices, etcetera), please check the source code (duh!) and our [CoMPAS Architecture Github Pages](https://com-pas.github.io/compas-architecture/).
165168

166169
#### Basic Maven Usage
167170
The project uses maven to manage the build. The configuration of all the tools is fairly standard, so if you have already contributed to Java projects, you should feel right at home. You can safely run the full test suite, checkstyle, see code coverage information and the generated documentation with the following command:

0 commit comments

Comments
 (0)