Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
89 lines (62 loc) · 3.75 KB

CONTRIBUTING.md

File metadata and controls

89 lines (62 loc) · 3.75 KB
Raw

Contributing to Trace Compass Infrastructure Repository

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.

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:

How to build the docker image (tag 22.04)

docker build --network host --no-cache -t eclipse/tracecompass-build-env:22.04 .

How to push the docker image to dockerHub under the eclipse organisation

docker push eclipse/tracecompass-build-env:22.04

Contact

For issues related to the infrastructure, please open a GitHub tracker for the Trace Compass Infrastructure or send an email to the Trace Compass mailing list.