Skip to content

Latest commit

 

History

History
101 lines (64 loc) · 3.84 KB

CONTRIBUTING.md

File metadata and controls

101 lines (64 loc) · 3.84 KB

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.

How to Contribute

We welcome contributions in the following areas:

  • Bug Reports: Identify and report bugs or issues in the project.
  • Feature Requests: Suggest enhancements or new features.
  • Code Contributions: Provide fixes, improvements, or new functionality.
  • Documentation: Improve existing documentation or add new guides and tutorials.

Contribution Principles

  • Avoid Company-Specific Setup: Contributions should not include configurations, dependencies, or tools specific to a single organization.
  • Avoid Proprietary Tooling: Do not include components or infrastructure that require subscriptions, licenses, or proprietary tools.
  • Be Vendor and Cloud Agnostic: Ensure that your contributions are neutral and compatible with a wide range of vendors, platforms, and cloud providers.

Best Practices

  • Write Documentation: Ensure that new features or changes are well-documented for others to understand and use.
  • Collaborate: Engage with the community through issues and discussions to align your contributions with the project's vision.
  • Iterate: Start with small, incremental changes to allow for easier review and feedback.

Resources

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

Developer resources

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

Getting started:

The project maintains the following source code repositories

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.

Eclipse Contributor Agreement

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

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.