Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 3.53 KB

CONTRIBUTING.md

File metadata and controls

51 lines (32 loc) · 3.53 KB

Contributing to Data Curator

Firstly, thanks for being here. All types of contributions are valued and gratefully received. You can contribute:

Contribute Financial Support

The best way to contribute financially to this project is to contact QCIF to discuss sponsoring a new feature and dedicated support options.

Contribute Ideas and Feature Requests

Your idea for a feature addition may already exist on our issues backlog or feature backlog. If a similar idea is in the backlog, please join the conversation.

If the gist of your idea isn't there:

Contribute Issues

If you encounter a problem, please add an issue. Make sure it isn't already reported.

In order for us to best respond to the issue, we need as much information about the issue as you can provide. Please provide a descriptive name for your issue and provide us with as much detail as possible.

Contribute Documentation

Help documentation is being drafted in a separate repository. Feel free to contribute.

Contribute Code

Data Curator is open source, and we a grateful for all code contributions. By participating in this project, you agree to abide by our Code of Conduct.

Before you start coding, please reach out to us either by email [email protected] or by tagging a repository administrator on an issue you'd like to contribute towards.

If this is your first time contributing to the ODI Australian Network’s codebase you will need to create a fork of this repository.

Follow the readme instructions to get your Development environment running locally.

Ensure that the automated tests pass before starting work on your contribution.

Code Review Process

All contributions to the codebase - whether fork or pull request - will be reviewed per the below criteria. To increase your chances of your push being accepted please be aware of the following

  • Write well formed commit messages
  • Write tests for all changes (additions or refactors of existing code).
  • We may use github integrations to check your contribution.
  • Once your PR is published and passes the above checks a repository administrator will review your contribution. Where appropriate comments may be provided and amendments suggested before your PR is merged into Master.