Contributing

Contributing to HeavyDB

HeavyDB is maintained by the Developer Advocate Team at NVIDIA and contributors, like you, to whom we are very grateful.

Getting In Touch

Have questions? Post questions and get answers on the official online forum and community or create an issue in the repo.

Making your first contribution?

We encourage contributors to:

• understand how your skill set and projects can fit into the roadmap
• help design new features and guide functionality
• share the latest demos you create using this open source project
• build and explore unique data sets
• join a community of developers and data lovers

Issues

Creating an issue

The project contains an issue template which should help guiding you through the process. If you have have additional questions, please post questions on the official online forum and community.

As a best practice, please consider logging an issue before beginning work on a pull request to allow for additional discussion with maintainers.

Working on an issue

See an issue you would like to start working on? Post your intention to work on the bug, feature or issue directly in the issue. This will help everyone save time and prevent doubling up on work.

Pull requests

These are a few guidelines to keep in mind when opening pull requests, there is a GitHub template that reiterates most of the points described here.

Commits & Correspondence

Help the maintainers by keeping 1-to-1 correspondence about commits and issues. Please format commit messages as follows:

Name of Component: add a description for the issue

Writing & Creating Tests

If you create tests, as a best practice, please add corresponding tests to feature(s) you are working on and contributing. This will help maintainers keep track of what is tested or needs additional testing before merging.

Review & Feedback

Reviews happen regularly during weekdays. If you notice that your pull request has not been attended to, please ping the maintainers in the pull request to learn more.

How to Get Your Pull Request Merged

Based on scheduling and resource availability, it is possible to experience some wait time before your pull request is approved and merged.

Code Style

Contributed code should compile without generating warnings by recent compilers on most Linux distributions. Changes to the code should follow the C++ Core Guidelines.

Contributor License Agreement (CLA)

Review and follow the Contribution Guidelines