Skip to content

Latest commit

 

History

History
101 lines (70 loc) · 4.42 KB

CONTRIBUTING.md

File metadata and controls

101 lines (70 loc) · 4.42 KB
Raw

Contributing to Trace Compass Test Traces

Thanks for your interest in this project.

How to Contribute

In order to contribute, please first open an issue that clearly describes the bug you intend to fix or the feature you would like to add.

Once you have your code ready for review, please open a pull request. Please follow the pull request guidelines. A committer of the Trace Comass project will then review your contribution and help to get it merged.

Terms of Use

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

Code of Conduct

This project is governed by the Eclipse Community Code of Conduct. By participating, you are expected to uphold this code.

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.

Adding a new test trace (CTF or Ftrace)

Note the description below describes the procedure for CTF. For Ftrace, the procedure is the same. Just replace ctf with ftrace and Ctf with Ftrace respectively.

The modules follow the [Maven standard directory layout][].

To add a new CTF test trace, add it to the ctf/src/main/resources directory. Make sure it is not archived or anything, as this will be exposed as-is to the users.

Then update the ctf/src/main/java/.../CtfTestTrace.java file accordingly to include the new trace.

Make sure the parameters (event count, etc.) are correct! This project does not check those at the moment, but if they are incorrect they will fail some Trace Compass unit tests. This is a known issue.

Finally, bump the project's minor version (1.7.0 -> 1.8.0) in the main pom.xml and related <parent> blocks.

Pull request guidelines

Changes to the project are made by submitting code with a pull request (PR).

Good commit messages make it easier to review code and understand why the changes were made. Please include a:

  • Title: Concise and complete title written in imperative (e.g. "Update Gitpod demo screenshots" or "Single-click to select or open trace")
  • Problem: What is the situation that needs to be resolved? Why does the problem need fixing? Link to related issues
  • Solution: What changes were made to resolve the situation? Why are these changes the right fix?
  • Impact: What impact do these changes have? (e.g. Numbers to show a performance improvement, screenshots or a video for a UI change)

Other commit information:

Contact

For issues related to the Trace Compass test traces, please open a GitHub tracker for the Trace Compass Test Traces or send an email to the Trace Compass mailing list.