Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

62 lines (41 loc) · 1.81 KB
Raw

Contributing to Pilosa

Reporting a bug

If you have discovered a bug and don't see it in the github issue tracker, open a new issue

Submitting a feature request

Feature requests are managed in Github issues. New features typically go through a Proposal Process which starts by opening a new issue that describes the new feature proposal.

Submitting code changes

Before you start working on new features, you should open a new issue to let others know what you're doing before you start working, otherwise you run the risk of duplicating effort. This also gives others an opportunity to provide input for your feature.

If you want to help but you aren't sure where to start, check out our github label for low-effort issues.

  • Fork the Pilosa repository and then clone your fork:

    git clone [email protected]:<your-name>/pilosa.git

  • Create a local feature branch:

    git checkout -b something-amazing

  • Commit your changes locally using git add and git commit.

  • Make sure that you've written tests for your new feature, and then run the tests:

    make test

  • Verify that your pull request is applied to the latest version of code on github:

    git remote add upstream [email protected]:pilosa/pilosa.git
git fetch upstream
git rebase -i upstream/master

  • Push to your fork:

    git push -u <yourfork> something-amazing

  • Submit a pull request