Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (44 loc) · 3.77 KB

CONTRIBUTING.md

File metadata and controls

72 lines (44 loc) · 3.77 KB
Raw

Contributing Guide

Thank you for taking the time to contribute! 🎉 👍

The following is a set of guidelines for contributing to DataReporter. These are guidelines, not rules, please use your best judgement and feel free to propose changes to this document in a pull request.

Quick Links:

⭐ If you already here and love the project, please make sure to press the Star button. ⭐

Table of Contents

How can I contribute?

Additional Notes

How can I contribute?

Reporting Bugs

When creating a new bug report, please make sure to:

  • Search for existing issues first. If you find a previous report of your issue, please update the existing issue with additional information instead of creating a new one.
  • If you are not sure if your issue is really a bug or just some configuration / setup problem, please start a discussion in GitHub Discussions first. Unless you can provide clear steps to reproduce, it's probably better to start with a thread in the discussions and later to open an issue.
  • If you still decide to open an issue, please review the template and guidelines and include as much details as possible.

Suggesting Enhancements / Feature Requests

If you would like to suggest an enhancement or ask for a new feature:

  • Please check GitHub Discussions for existing threads about what you want to suggest/ask. If there is, feel free to upvote it to signal interest or add your comments.
  • If there is no open thread, you're welcome to start one to have a discussion about what you want to suggest. Try to provide as much details and context as possible and include information about the problem you want to solve rather only your proposed solution.

Pull Requests

  • Code contributions are welcomed. For big changes or significant features, it's usually better to reach out first and discuss what you want to implement and how (we recommend reading: Pull Request First). This to make sure that what you want to implement is aligned with our goals for the project and that no one else is already working on it.
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Please add documentation for new features or changes in functionality along with the code.
  • Please follow existing code style:
    • Python: we use Black to auto format the code.
    • Javascript: we use Prettier to auto-format the code.

Documentation

The project's documentation can be found at https://datareporter.com/docs/. The documentation sources are hosted on GitHub. To contribute edits / new pages, open a pull request against the docs repository.

Additional Notes

Release Method

We publish releases as Docker images. Every build of the main branch updates the Docker image.

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to security@datareporter.com.