From e2e4beb8a3b5ffb2f1fcf6c993c56d516e673d94 Mon Sep 17 00:00:00 2001 From: Vinicius Brasil Date: Thu, 28 Jul 2022 17:17:21 -0300 Subject: [PATCH] Add 'Finding a task' section to CONTRIBUTING.md --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e85f16165..b20d7761e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,7 @@ # Contributing +We welcome everyone to contribute to Plausible. This document is to help you on setting up your environment, finding a task, and opening pull requests. + ## Development setup The easiest way to get up and running is to [install](https://docs.docker.com/get-docker/) and use Docker for running both Postgres and Clickhouse. @@ -39,3 +41,11 @@ Note: Since we are deleting the containers, be careful when deleting volumes wit ### Pre-commit hooks `pre-commit` requires Python to be available locally and covers Elixir, JavaScript, and CSS. Set up with `pip install --user pre-commit` followed by `pre-commit install`. Conversely, if the prompts are far too bothersome, remove with `pre-commit uninstall`. + +## Finding a task + +Bugs can be found in our [issue tracker](https://github.com/plausible/analytics/issues). Issues are usually up for grabs. + +New features need to be discussed with the core team and the community first. If you're tackling a feature, please make sure it has been already discussed in the [Discussions tab](https://github.com/plausible/analytics/discussions). We kindly ask contributors to use the discussion comment section to propose a solution before opening a pull request. + +Pull requests without an associated issue or discussion may still be merged, but we will focus on changes that have already been talked through.