Skip to content

Latest commit

 

History

History
149 lines (95 loc) · 4.84 KB

CONTRIBUTING.md

File metadata and controls

149 lines (95 loc) · 4.84 KB
Raw

Contributing Guidelines

Parca is licensed under the Apache 2.0 license and accept contributions via GitHub pull requests. This document outlines some of the conventions on development workflow, commit message formatting, contact points and other resources to make it easier to get your contribution accepted.

Certificate of Origin

By contributing to this project you agree to sign a Contributor License Agreement(CLA).

Code of Conduct

Parca follows the CNCF Code of Conduct. Please contact the Parca maintainers at [email protected] to report any CoC violations.

Prerequisites

Install the following dependencies (Instructions are linked for each dependency).

Getting Started

Fork and clone the parca repository on GitHub to your machine.

$ git clone [email protected]:<your-github-username>/parca.git

Go to the project directory and compile parca:

$ cd parca

$ make build

Run the binary locally.

./bin/parca

Once compiled the server ui can be seen at http://localhost:7070.

To profile all containers using Kubernetes, the parca-server can be run alongside parca-ui using Tilt.

$ cd parca

$ make dev/setup

$ make dev/up

$ tilt up

Test your changes by running:

$ cd parca && make go/test

Making a PR

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. If you are not entirely sure about this, you can discuss this on the Parca Discord server as well. RFCs are used to document all things architecture and design for the Parca project. You can find an index of the existing RFCs here.

Please make sure to update tests as appropriate.

This is roughly what the contribution workflow should look like:

  • Create a topic branch from where you want to base your work (usually main).
  • Make commits of logical units.
  • Make sure the tests pass, and add any new tests as appropriate.
  • Make sure your commit messages follow the commit guidelines (see below).
  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the original repository.

Thank you for your contributions!

Sending a bug fix

Let's say you want to send a bug fix for v0.8.x. The workflow is as follow:

git checkout release-0.8
git checkout --branch my-fix
# start working on your fixes
git add .
git commit -m "Fix xyz"
git push origin my-fix

Then open your Pull Request and make sure to select release-0.8 as the base to send your changes on to. That way we can include them in the next patch release. Eventually, we are merging the release-0.8 back into main, so that all your bug fixes are in newer versions too.

Commit Guidelines

We follow a rough convention for commit messages that is designed to answer two questions: what changed and why. The subject line should feature the what and the body of the commit should describe the why.


scripts: add the test-cluster command

this uses tmux to setup a test cluster that you can easily kill and
start for debugging.

Fixes #38

The first line is the subject and should be no longer than 70 characters, the second line is always blank, and other lines should be wrapped at 80 characters. This allows the message to be easier to read on GitHub as well as in various git tools.

Code Formatting Guidelines

Go

The Go code is formatted using gofumpt, a stricter go fmt, and more linting is done using golangci-lint. To check your newly written Go code you can run make go/lint which will tell you all the things needing to fix. If you forget to run it locally our CI will run it too and add comments on your PR.

UI

We use Prettier for code formatting the files in the UI project. The following are the configuration overrides over Prettier's defaults:

  1. printWidth: 100
  2. singleQuote: true
  3. bracketSpacing: false
  4. arrowParens: 'avoid'

pre-commit

pre-commit hooks can installed to help with the linting and formatting of your code:

pre-commit install