Skip to content

Contributing

snowcrash007 edited this page Aug 1, 2019 · 5 revisions

Contributing to OmniSciDB

OmniSciDB is maintained by the Developer Advocate Team at OmniSci 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?

Contribution Wishlist

Check out contribution wishlist with highlighted issues that would make great first contributions to this project.

Roadmap

We also recommend visiting the Roadmap to learn more about upcoming features or by checking out the Issues to see the latest updates or proposed content.

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

You can also learn more about additional open source projects OmniSci is working on by visiting the primary OmniSci GitHub page.

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.

If you're on the hunt for great first contributions, we've collected all of the issues that would make great first contributions on our contribution wishlist.

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)

In order to clarify the intellectual property license granted with Contributions from any person or entity, OmniSci must have a Contributor License Agreement ("CLA") on file that has been signed by each Contributor, indicating agreement to the Contributor License Agreement.

After making a pull request, a bot will notify you if a signed CLA is required and provide instructions for how to sign it. Please read the agreement carefully before signing and retain a copy for your records.