CONTRIBUTING.md

Contributing to Eclipse Tractus-X

Thanks for your interest in this project.

Project description

The companies involved want to increase the automotive industry's competitiveness, improve efficiency through industry-specific cooperation and accelerate company processes through standardization and access to information and data. A special focus is also on SMEs, whose active participation is of central importance for the network's success. That is why Catena-X has been conceived from the outset as an open network with solutions ready for SMEs, where these companies will be able to participate quickly and with little IT infrastructure investment. Tractus-X is meant to be the PoC project of the Catena-X alliance focusing on parts traceability.

• https://projects.eclipse.org/projects/automotive.tractusx

Project licenses

The Tractus-X project uses the following licenses:

• Apache-2.0 for code
• CC-BY-4.0 for non-code

Terms of Use

This repository is subject to the Terms of Use of the Eclipse Foundation

• https://www.eclipse.org/legal/termsofuse.php

Developer resources

Information regarding source code management, builds, coding standards, and more.

• https://projects.eclipse.org/projects/automotive.tractusx/developer

The project maintains the source code repositories in the following GitHub organization:

• https://github.com/eclipse-tractusx/

Eclipse Development Process

This Eclipse Foundation open project is governed by the Eclipse Foundation Development Process and operates under the terms of the Eclipse IP Policy.

• https://eclipse.org/projects/dev_process
• https://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf

Eclipse Contributor Agreement

In order to be able to contribute to Eclipse Foundation projects you must electronically sign the Eclipse Contributor Agreement (ECA).

• http://www.eclipse.org/legal/ECA.php

The ECA provides the Eclipse Foundation with a permanent record that you agree that each of your contributions will comply with the commitments documented in the Developer Certificate of Origin (DCO). Having an ECA on file associated with the email address matching the "Author" field of your contribution's Git commits 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

Contact

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

• https://accounts.eclipse.org/mailing-list/tractusx-dev

Hand's On PURIS!

To directly participate in the development of PURIS feel free to create an issue for Bugs or Features (User Story) in repository.

You can also take over existing issues or just fix things directly in a pull request. To do so:

1. Create a fork (in tab Code of this repository on the right side, same row as repository name > click fork)
2. Clone your fork (copy commands for clone via green Code dropdown)
3. Checkout a new branch
4. Do the work.
   • Follow conventional commits
   • Checkout development documentation for frequent questions
   • Checkout Tractus-X Release Guidelines e.g., for open source questions
   • Run the tests and local deployment (and refresh information in the view) to ensure you broke nothing
5. Push your work and create a PR, best with linking to the issue via # and a meaningful description.
   • Check that dependencies are up to date (if not done)
   • Check and resolve pipeline results
   • Request the review (if you're contributor)
6. Iterate over the code changes with the Committers!

Get in touch!

Checkout the open meetings to get in touch and find mentors and ask contributors on how things are done.