From d9ec669d5b73710f5d3a3f6aeb32095fc1a48156 Mon Sep 17 00:00:00 2001 From: Niko Date: Fri, 24 Jan 2025 16:43:13 +0100 Subject: [PATCH] added branch overview --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 752418e2..d7f8a4a4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,6 +18,28 @@ $env:SPOTIPY_CLIENT_USERNAME="client_username_here" $env:SPOTIPY_REDIRECT_URI="http://localhost:8080" ``` +### Branch Overview + +After restarting development on version 3, we decided to restrict commits to certain branches in order to push the development forward. +To give you a flavour of what we mean, here are some examples of what PRs go where: + +**v3**: + +- any kind of refactoring +- better documentation +- enhancements +- code styles + +**master (v2)**: + +- bug fixes +- deprecations +- new endpoints (until we release v3) +- basic functionality + +Just choose v3 if you are unsure which branch to work on. + + ### Create virtual environment, install dependencies, run tests: ```bash