Skip to content

Commit

Permalink
Merge pull request #740 from catenax-ng/chore/#389-update-CONTRIBUTING
Browse files Browse the repository at this point in the history
chore(CONTRIBUTION):[#389] add matrix chat and stuff for consultants
  • Loading branch information
mkanal authored Jan 26, 2024
2 parents f3d25d6 + 1578604 commit cec9b85
Showing 1 changed file with 53 additions and 2 deletions.
55 changes: 53 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@

Thanks for your interest in this project.

# Table of Contents
1. [Project description](#project-description)
2. [Developer resources](#developer-resources)
3. [Eclipse Development Process](#eclipse-development-process)
4. [Eclipse Contributor Agreement](#eclipse-contributor-agreement)
5. [General contribution to the project](#general-contribution-to-the-project)
6. [Contributing as a Consultant](#contributing-as-a-consultant)
7. [Contributing as a Developer](#contributing-as-a-developer)
9. [Contact](#contact)

## Project description

The companies involved want to increase the automotive industry's
Expand Down Expand Up @@ -53,7 +63,7 @@ fulfills the DCO's requirement that you sign-off on your contributions.
For more information, please see the Eclipse Committer Handbook:
https://www.eclipse.org/projects/handbook/#resources-commit

# Eclipse Dependency License Check
## Eclipse Dependency License Check

In case of new dependencies or version updates, it might be necessary to have the new library checked and accepted by the Eclipse foundation. Do create new tickets for this, you can use this command:
```
Expand All @@ -62,6 +72,45 @@ mvn org.eclipse.dash:license-tool-plugin:license-check -Ddash.iplab.token=$ECLIP

For more information on the tool and how to acquire the token, check https://github.com/eclipse/dash-licenses.

## General contribution to the project


## Contributing as a Consultant

### Conceptual work and specification guidelines
1. The prerequisite for a concept is always a github issue that defines the business value and the acceptance criteria that are to be implemented with the concept
2. Copy and rename directory /docs/#000-concept-name-template /docs/#<DDD>-<target-name>
3. Copy file /docs/Concept_TEMPLATE.md into new directory /docs/#<DDD>-<target-name>

### Diagrams
PlantUML and Mermaid is used for conceptual work.
https://mermaid.js.org/
https://plantuml.com/


#### PlantUML
default skinparam for plantUml diagrams
````
@startuml
skinparam monochrome true
skinparam shadowing false
skinparam linetype ortho
skinparam defaultFontName "Architects daughter"
autonumber "<b>[000]"
@enduml
````

#### Mermaid
Default header for mermaid sequence diagrams
````
sequenceDiagram
%%{init: {'theme': 'dark', 'themeVariables': { 'fontSize': '15px'}}}%%
autonumber
````

## Contributing as a Developer

### Commit messages
The commit messages have to match a pattern in the form of:
``< type >(scope):[<Ticket_ID>] < description >``
Expand All @@ -80,11 +129,13 @@ cp local/development/commit-msg .git/hooks/commit-msg && chmod 500 .git/hooks/co

For further information please see https://github.com/hazcod/semantic-commit-hook

## Code formatting
### Code formatting
Please use the following code formatter: [.idea/codeStyles](.idea/codeStyles)


## Contact

Contact the project developers via the project's "dev" list.

* https://accounts.eclipse.org/mailing-list/tractusx-dev
* Eclipse Matrix Chat https://chat.eclipse.org/#/room/#tractusx-irs:matrix.eclipse.org

0 comments on commit cec9b85

Please sign in to comment.