From 60043fff598d095d9e57db5ffbed96ab7092c6f7 Mon Sep 17 00:00:00 2001 From: vabene1111 Date: Fri, 23 Sep 2022 17:07:04 +0200 Subject: [PATCH] changed contributions guidelines, please ask/talk first about new features --- README.md | 3 +-- docs/contribute.md | 9 +++++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 71e5e924..28dc83ed 100644 --- a/README.md +++ b/README.md @@ -71,8 +71,7 @@ Because of that there are several ways you can support us - **Let us host for you** We are offering a [hosted version](https://app.tandoor.dev) where all profits support us and the development of tandoor (currently only available in germany). ## Contributing - -You can help out with the ongoing development by looking for potential bugs in our code base, or by contributing new features. We are always welcoming new pull requests containing bug fixes, refactors and new features. We have a list of tasks and bugs on our issue tracker on Github. Please comment on issues if you want to contribute with, to avoid duplicating effort. +Contributions are welcome but please read [this](https://docs.tandoor.dev/contribute/#contributing-code) **BEFORE** contributing anything! ## Your Feedback diff --git a/docs/contribute.md b/docs/contribute.md index 170c3aeb..592c3368 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -11,8 +11,13 @@ over at [GitHub issues](https://github.com/vabene1111/recipes/issues). Without feedback improvement can't happen, so don't hesitate to say what you want to say. ## Contributing Code -Code contributions are always welcome. There are no special rules for what you need to do, -just do your best and we will work together to get your idea and code merged into the project. +If you want to contribute bug fixes or small tweaks then your pull requests are always welcome! + +!!! danger "Discuss First!" + If you want to contribute larger features that introduce more complexity to the project please + make sure to **first submit a technical description** outlining what and how you want to do it. + This allows me and the community to give feedback and manage the complexity of the overall + application. If you don't do this please don't be mad if I reject your PR !!! info The dev setup is a little messy as this application combines the best (at least in my opinion) of both Django and Vue.js.