CONTRIBUTING.asciidoc

Contributing to Eclipse TRACE4CPS™

This guide provides all necessary information to enable contributors and committers to contribute to Eclipse TRACE4CPS™.

Contributions are always welcome!

Eclipse TRACE4CPS™

Eclipse TRACE4CPS™ is a customizable, domain-independent and source-independent Gantt chart viewer with mathematically-founded analysis support. Eclipse TRACE4CPS™ supports the visualization of activities on resources as a function of time (Gantt charts), as well as the visualization of continuous signals. Eclipse TRACE4CPS™ also supports several analysis techniques to identify bottlenecks, check formally-specified (performance) properties, and analyze resource usage. A key feature of Eclipse TRACE4CPS™ is the ability to configure the identification, selection and visualization of such information to match any specific application domain.

For more information, see:

• Project home: https://projects.eclipse.org/projects/technology.trace4cps

• Website: https://eclipse.org/trace4cps

Developer resources

For more information regarding source code management, builds, setting up a developer environment, coding standards, how to contribute, and more, see:

• https://projects.eclipse.org/projects/technology.trace4cps/developer

The project maintains the following source code repositories:

• https://gitlab.eclipse.org/eclipse/trace4cps/trace4cps.git

These can also be accessed via a web interface:

• https://gitlab.eclipse.org/eclipse/trace4cps/trace4cps

This project uses GitLab to track ongoing development and issues:

• https://gitlab.eclipse.org/eclipse/trace4cps/trace4cps/-/milestones

• https://gitlab.eclipse.org/eclipse/trace4cps/trace4cps/-/issues

Be sure to search for existing issues before you create another one. Remember that contributions are always welcome!

To contribute source code (e.g. patches), please use GitLab:

• https://gitlab.eclipse.org/eclipse/trace4cps/trace4cps/-/merge_requests

Eclipse Contributor Agreement

Before your contribution can be accepted by the project team, contributors must electronically sign the Eclipse Contributor Agreement (ECA), see:

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

Commits that are provided by non-committers must have a Signed-off-by field in the footer indicating that the author is aware of the terms by which the contribution has been provided to the project. The non-committer must additionally have an Eclipse Foundation account and must have a signed Eclipse Contributor Agreement (ECA) on file.

For more information, please see the Eclipse Committer Handbook:

• https://www.eclipse.org/projects/handbook/#resources-commit

How to contribute

The Eclipse TRACE4CPS™ source code can be found here.

How to build and setup a development environment can be found here.

Whenever new packages are added make sure to document them in the code overview section.

Contact

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

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