Skip to content

Latest commit

 

History

History
114 lines (86 loc) · 6.3 KB

CONTRIBUTING.md

File metadata and controls

114 lines (86 loc) · 6.3 KB

Contributing to Trace Viewer VS Code extension

Thanks for your interest in the Trace Viewer VS Code extension!. The following is a set of guidelines for contributing to the Trace Viewer extension for VS Code compatible tools. Information about the trace viewer capabilities can also be found in the Trace Viewer Theia extension repository and its issue tracers.

How to Contribute

⚠️ Important note Setting up the development environment on Linux is the easiest. If you are trying to run the project on Windows or MacOs and you are encountering issues, please contact us. Follow the installation instruction in the README.

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. Make sure you provide a way to reproduce the bug or test the proposed feature.

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

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 (e.g. "Fixes #55").
  • 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)
  • Sign-off: Use your full name and a long-term email address. This certifies that you have written the code and that, from a licensing perspective, the >
  • How to format the message
  • Example commit message

Formatting code with Prettier

If a commit fails to pass CI checks because of its format, contributors can use Prettier, which is already conveniently set up in the project, to quickly format their commit.

  • To format a single file, simply run yarn prettier --write <path-to-file>.
  • To run Prettier on all source code files, run yarn format:write. Prettier will only format files that are not formatted correctly.
  • To check if new changes comply with Prettier rules, run yarn prettier --check <path-to-file> or yarn format:check to perform the check on a single file or all source code file, respectively.

Ignoring linting/formatting commits

Should one be needing to use git blame to view the changes that were made recently to a file, it might be necessary to ignore the changes that were made in linting/formatting commits. In the root of the repo, there is a .git-blame-ignore-revs file. Adding the SHA-1 of a commit to this file will make git-blame ignore that commit. To use this file:

  • For GitHub, this file is automatically detected and will ignore all the commits that are included in the file.
  • With Git CLI, run git blame --ignore-revs-file=.git-blame-ignore-revs <pathToSomeFile> to ignore the commits. <<<<<<< HEAD
  • git config --global blame.ignoreRevsFile .git-blame-ignore-revs will automatically detect these files for every repository. =======

d126837 (Repository formatted with prettier)

Contact

For issues related to this extension, please open a GitHub tracker for the VS Code Trace Extension repository.

For issues concerning eclipse-cdt-cloud, please refer to the contact options listed on the CDT Cloud website.