diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7c60316fc..4e8c863c1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,35 +4,57 @@ Thank you for taking the time to contribute! :tada::+1: 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: + +- [Feature Roadmap](https://trello.com/b/b2LUHU7A/re-dash-roadmap) +- [Feature Requests](https://discuss.redash.io/c/feature-requests) +- [Gitter Chat](https://gitter.im/getredash/redash) or [Slack](https://slack.redash.io) +- [Documentation](http://docs.redash.io) +- [Blog](http://blog.redash.io/) +- [Twitter](https://twitter.com/getredash) + +-------- +:star: If you already here and love the project, please make sure to press the Star button above. :star: + +-------- + ## Table of Contents [How can I Contribute?](#how-can-i-contribute) - [Reporting Bugs](#reporting-bugs) -- [Suggesting Enhancements](#suggesting-enhancements) +- [Suggesting Enhancements / Feature Requests](#suggesting-enhancements-feature-requests) - [Pull Requests](#pull-requests) +- [Documentation](#documentation) - Design? -[Styleguides](#styleguides) - [Code of Conduct](#code-of-conduct) ## How can I contribute? ### Reporting Bugs -### Suggesting Enhancements +When creating a new bug report, please make sure to: -- check roadmap and existing suggestions -- describe what you want & your solution +- 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](https://discuss.redash.io/c/support) 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 enchancement or ask for a new feature: + +- Please check [the roadmap](https://trello.com/b/b2LUHU7A/re-dash-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](https://discuss.redash.io/c/feature-requests) 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 -... - -## Styleguides - -... +- **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](https://medium.com/practical-blend/pull-request-first-f6bb667a9b6#.ozlqxvj36)). 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](#documentation) for new features or changes in functionality along with the code. +- Please follow existing code style. We use PEP8 for Python and sensible style for Javascript. + +### Documentation ## Code of Conduct