Skip to content

Latest commit

 

History

History
52 lines (26 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

52 lines (26 loc) · 2.86 KB

How to contribute

Thanks for choosing to contribute to this project.

If you haven't already, please view the README for an introduction to the aims and intended use of this project.

Contributing as a user (non-development)

As a non-developer, you can still contribute in many ways. We are especially interesting in hearing from people using the project in production/working environments.

If you spot any problems, please raise an issue within the project and provide as much information as possible. This should enable us to recreate the issue and check that any fix is appropriate.

Feature requests can also be raised in the project as a new issue. Please detail what you may wish to be added, why you would benefit from it and any other information that may be relevant.

You may also wish to 'star' the project (click the star link on the project main page) to show your appreciation.

Contributing as a developer

Getting Started

If you are looking to lend your development skills to the project, you can check the projects issue list to see what people may be looking for. Developers who already have an idea of what they might like to change should consider creating an issue to indicate to others of the work they are undertaking and commence any discussion on the possible solutions.

Making Changes

Please fork the projects master branch to your own account. Using your fork, you are free to create changes or create branches in isolation.

The following provides a good general guide 'Beginners Guide To Contributing'

Please keep your fork up-to date to reduce the risk of conflicts occurring when your come to submit any changes.

It can also be worth considering if your changes may also require changes to documentation or dependent systems.

Submitting Changes

When committing changes, please provide a descriptive commit comment of why the change was made (e.g. 'fixed bug' is not a suitable comment as it doesn't describe which bug).

You can link to a relevant issue in a commit comment by referencing the issue number prefixed with a '#'.

After pushing to your fork, submit a pull request against the main projects master branch.

In order to have your pull request approved in a timely manner, please provide comments on the pull request that details what was changed & for which reasons. The complexity or size of the change indicate the size of the descriptions required, in order for the reviewer to get up to speed as quick as possible.

Additional Resources

Outline of HDF5 data format

HDF5 C api home page

HDF5 C api examples

KDB+ and q documentation