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
Before you start your coding journey within the CoMPAS project, there are some things we have to talk about.
122
+
Some things that will make your start a little bit easier!
123
+
124
+
#### Open Community Calls
125
+
It's good to know that every other monday, we are having a so called Open Community Call. Everyone participating in the CoMPAS project can join and talk about and ask question about the CoMPAS project.
126
+
127
+
When the Open Community Calls are taking place, can be found at the [General CoMPAS mailing list calendar](https://lists.lfenergy.org/g/CoMPAS/calendar).
128
+
129
+
The agendas can be found at the [LF Energy wiki](https://wiki.lfenergy.org/display/HOME/CoMPAS+Community+Calls).
130
+
131
+
If you have something to add, please add it to the agenda and notify everyone on Slack!
132
+
133
+
#### Slack channel
134
+
One of the first important things, is to meet the community. Feel free to introduce yourself on our [Slack channel](https://app.slack.com/client/TLU68MTML/C01926K9D39)!
135
+
136
+
The Slack channel is the first communication platform within the CoMPAS project (besides email and the Github platform), so if you need help for example you can use Slack!
137
+
138
+
#### Github
139
+
What's Github? It's where you're looking right now! (Joking!).
140
+
141
+
We are using Github for hosting our Git repositories. Github is being used for creating issues and creating Pull Requests to review / merge each others code.
142
+
143
+
#### Documenting
144
+
A good (open source) project requires documentation.
145
+
We have two places for our documentation
146
+
147
+
##### LF Energy Wiki
148
+
LF Energy has it's own [CoMPAS specific Wiki](https://wiki.lfenergy.org/display/HOME/CoMPAS). This is the place for documenation about CoMPAS in general (like roadmap and the community call agendas).
149
+
150
+
##### CoMPAS Architecture Github Pages
151
+
There is also a [Github Pages](https://com-pas.github.io/compas-architecture/) website for CoMPAS architecture specific topics.
152
+
153
+
#### Copyright and Licensing
154
+
Copyright and license information is done on per-file basis. We use the specification of [REUSE](https://reuse.software/spec/) to ensure that copyright information of the project is clear and can be analuzed in an automated fashion.
155
+
156
+
Every source code repository within CoMPAS has a Github Action for checking against the REUSE specification.
157
+
158
+
For more information, check the [Copyright Guidelines](#copyright-guidelines) section.
159
+
160
+
#### LFX Security Tool
161
+
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.
162
+
163
+
#### SonarCloud
164
+
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).
165
+
166
+
A Pull Request can't be merged before all SonarCloud issues are being fixed!
167
+
168
+
#### Architecture and technologies
169
+
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/).
170
+
118
171
#### Basic Maven Usage
119
172
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