Skip to content

Latest commit

 

History

History
46 lines (24 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

46 lines (24 loc) · 3.07 KB
Raw

Neon's Community and How to Contribute

The Neon team strongly believes in the open-source effort and we welcome and greatly appreciate contributions from the community: proposing new features, filing issues, and contributing code. The rest of the document describes various processes to give your contribution.

Providing Suggestions

Neon is meant to evolve with feedback from the community, and we greatly appreciate any thoughts on ways to improve the design or features. Please use the enhancement tag to denote issues that are suggestions specifically—this helps us triage and respond appropriately.

Filing Bugs

As with all software, you may run into bugs. Please submit bugs as regular issues on GitHub—we are regularly monitoring issues and will prioritize and schedule fixes.

The best bug reports include a detailed way to reproduce the issue predictably and possibly even a working example demonstrating the issue.

Contributing Code

There are three main steps for contributing your code to the project. First, sign a Contributor License Agreement, share your goal with the community, write your code following Neon coding standards, and finally, submit a pull request. Here are some more details on each of the steps.

Contributor License Agreement (CLA)

Before contributing any code to this project, we kindly ask you to sign a Contributor License Agreement (CLA). We can not accept any pull request if a CLA has not been signed.

  • If you are contributing on behalf of yourself, the CLA signature is included as a part of the pull request process.

  • If you are contributing on behalf of your employer, please sign our Corporate Contributor License Agreement. The document includes instructions on where to send the completed forms to. Once a signed form has been received, we can happily review and accept your pull requests.

Coordinate With the Community

We highly recommend opening an issue on GitHub to describe your goals before starting any coding. This will allow you to get early feedback and avoid multiple parallel efforts.

Coding Standard

To provide a more uniform code base, we would appreciate it if any new code could follow the coding standard described in this document: CodeConvention.md.

Git Workflow

We follow the GitFlow development model. If you would like to contribute your code to Neon, you should:

  • Include your work in a feature branch created from the Neon develop branch. The develop branch contains the latest work in Neon.
  • Then, create a pull request against the develop branch.

Periodically, we merge the develop branch into the main branch and tag a new release.

When contributing code, please include appropriate tests as part of the pull request, and follow the same comment and coding style as the rest of the project. Take a look through the existing code for examples of the testing and style practices the project follows.