valitydev/redash
14
0
Fork 0
mirror of https://github.com/valitydev/redash.git synced 2024-11-06 17:15:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
84f1218849
redash/CONTRIBUTING.md
Arik Fraimovich 84f1218849 Remove references to Gitter
2018-08-29 12:04:43 +03:00

4.6 KiB
Raw Blame History

Contributing Guide

Thank you for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to Redash. 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 the support forum first. Unless you can provide clear steps to reproduce, it's probably better to start with a thread in the forum 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 the roadmap for existing Trello card for 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 existing card, open a thread in the forum to start 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 PEP8 for Python.
    • Javascript: we use Airbnb's style guides for JavaScript and React (currently we don't follow Airbnb's convention for naming files, but we're gradually fixing this). To make it automatic and easy, we recommend using Prettier.

Documentation

The project's documentation can be found at https://redash.io/help/. The documentation sources are hosted on GitHub. To contribute edits / new pages, you can use GitHub's interface. Click the "Edit on GitHub" link on the documentation page to quickly open the edit interface.

Additional Notes

Release Method

We publish a stable release every ~2 months, although the goal is to get to a stable release every month. You can see the change log on GitHub releases page.

Every build of the master branch updates the latest RC release. These releases are usually stable, but might contain regressions and therefore recommended for "advanced users" only.

When we release a new stable release, we also update the latest Docker image tag, the EC2 AMIs and GCE images.

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 team@redash.io.