Skip to content

Latest commit

 

History

History
67 lines (40 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

67 lines (40 loc) · 3 KB

Contributing Guidelines

Pixie welcomes contributions from the community. This document outlines the conventions that should be followed when making a contribution.

Contact Us

For any questions regarding Pixie or the contribution process, feel free to reach out to us:

Where to start?

You can contribute to Pixie in many ways. This includes, but is not limited to:

  • Bug and feature reports
  • Documentation
  • Development of features and bug fixes

If you are interested in helping us shape our community, you can also apply here to be a Pixienaut.

Contribution Process

Reporting Bugs and Creating Issues

Reporting bugs is one of the most helpful ways to contribute to Pixie. Bugs may be reported by filing a Github issue in the appropriate repository. For bugs regarding Pixie, file an issue in the pixie repo. For reporting inaccurate documentation, file an issue in the pixie-docs repo, etc. Please follow the template when filing an issue and provide as much information as possible.

Before reporting a bug, we encourage you to search the existing Github issues to ensure that the bug has not already been filed.

Code Contributions

The project is still in its early stages, and we are a small team actively working on delivering our roadmap. For all changes, regardless of size, please create a Github issue that details the bug or feature being addressed before submitting a pull request. In the Github issue, contributors may discuss the viability of the solution, alternatives, and considerations.

Contribution Roadmap

As we are still an early-stage open source project, more changes to the contribution guidelines will follow in the coming months. We are actively working on opening our JIRA for issue tracking.

Contribution Flow

  1. Steps to making a code contribution to Pixie will generally look like the following:
  2. Fork the repository on Github.
  3. Create a new branch.
  4. Make your changes in organized commits.
  5. Push your branch to your fork.
  6. Submit a pull request to the original repository.
  7. Make any changes as requested by the maintainers.
  8. Once accepted by a maintainer, it will be merged into the original repository by a maintainer.

Contribution Checklist

When making a contribution to the repository, please ensure that the following is addressed.

  1. Code follows Pixie’s coding style guide.
  2. All existing tests must pass, and new tests must be added for the bug/feature in question.
  3. Contributor License agreement must be signed.

Coding Style

Please refer to the style guide directory for more details.

Commit Messages

Commit messages should provide enough information about what has changed and why. Please follow the templates for how this information should be detailed.

CLA

All code contributions require the Contributor License Agreement. The CLA can be signed when creating your first PR.