Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (44 loc) · 3.8 KB

CONTRIBUTING.md

File metadata and controls

70 lines (44 loc) · 3.8 KB

Contributing Guidelines

Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.

Reporting Bugs/Feature Requests

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

  • A reproducible test case or series of steps
  • The version of our code being used
  • Any modifications you've made relevant to the bug
  • Anything unusual about your environment or deployment

Finding contributions to work on

Looking at the existing issues is a great way to find something to contribute to. We label issues that are well-defined and ready for community contributions with the "ready for contribution" label.

Check our "Ready for Contribution" issues for items you can work on:

Before starting work on any issue:

  1. Check if someone is already assigned or working on it
  2. Comment on the issue to express your interest and ask any clarifying questions
  3. Wait for maintainer confirmation before beginning significant work

Contributing via Pull Requests

Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:

  1. You are working against the latest source on the main branch.
  2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
  3. You open an issue to discuss any significant work - we want to make sure your time is well spent.

To send us a pull request, please:

  1. Fork the repository.
  2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
  3. Ensure local tests pass.
  4. Commit to your fork using clear commit messages.
  5. Send us a pull request, answering any default questions in the pull request interface.
  6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

GitHub provides additional document on forking a repository and creating a pull request.

Finding contributions to work on

Looking at the existing issues is a great way to find something to contribute to. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.

Code of Conduct

Security issue notifications

If you discover a potential security issue in this project, we ask that you notify us . Please do not create a public github issue.

Slack Datu community

The slack community channel is your go-to place to connect with other users, ask questions, share tips, and stay up to date on the project. Whether you’re looking for help, want to see how others are using the tool, or just want to chat about ideas, Datu Community Slack is the place to go.

Licensing

See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.