Skip to main content
Release: Jupiter (preview)

Tractus-X Open Source Project Contribution Guide

Welcome to the Tractus-X open source project! This guide is designed to help you understand how you can contribute to the Tractus-X project. There are different levels of contributions you can make, such as standard contributions, feature contributions and improvements. Below you'll find the steps and guidelines for each.

Understanding Tractus-X​

Before contributing, it's important to have a good understanding of what Tractus-X is and what it aims to achieve. Tractus-X is a collaborative effort to create FOSS applications enabling the Catena-X dataspace core services for trusted and effective exchange. Familiarize yourself with the project's goals, architecture, and existing features by reviewing the documentation and codebase.

General Contribution Guidelines​

Regardless of the type of contribution, here are some general guidelines to follow:

  • Read the Contribution Guidelines: Before contributing, make sure to read the project's contribution guidelines thoroughly.
  • Code of Conduct: Adhere to the project's code of conduct to maintain a respectful and collaborative environment.
  • Stay Updated: Regularly pull the latest changes from the main branch to keep your local repository up-to-date.
  • Communicate: Engage with the community through issues, pull requests, and discussions to collaborate effectively.
  • Write Tests: If you're contributing code, make sure to write tests that cover your changes.
  • Documentation: Update or add documentation as necessary to reflect your changes or new features.

By following these guidelines, you can make valuable contributions to the Tractus-X project and help drive its success. Thank you for your interest in contributing to Tractus-X!