Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

55 lines (40 loc) · 2.53 KB
Raw

Contributing to Manifold

Great to have you here. Here are a few ways you can help make manifold even better!

Note that you'll need to sign Uber's Contributor License Agreement before we can accept any of your contributions.

Code of Conduct

Help us keep manifold open and inclusive. Please read and follow our Code of Conduct.

Issues and Bugs

If you find a bug, you can help us by submitting an Issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Feature Requests

If you want to contribute or add new features, please use Issue on github projects to start a new discussion. If you receive a go-ahead, you can submit your patch as PR to the repository.

If you are looking for inspiration on feature ideas, we list our planned features in our roadmap. We will prioritize our review and support for pull requests related to items on the list.

Submitting Pull Request

  • Search GitHub for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.

  • Create the development environment

  • Make your changes in a new git branch:

    git checkout -b my-fix-branch master

  • Create your patch commit, including appropriate test cases.

  • If the changes affect public APIs, change or add relevant documentation.

  • Run tests and ensure that all tests pass.

  • Commit your changes using a descriptive commit message. Adherence to the conventions is required, because release notes are automatically generated from these messages.

  • All pull requests will be reviewed by @uber/mlvis team

Releases and versioning

After changes are merged, a new version will be released as appropiate. Historical releases are maintained on separate branches. There are two lines of release branches, one for the main packages and one for the Jupyter bindings.

release-1.0.0 
release-jupyter-0.1.0