added branch overview

This commit is contained in:
Niko 2025-01-24 16:43:13 +01:00 committed by GitHub
parent c738376b80
commit d9ec669d5b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -18,6 +18,28 @@ $env:SPOTIPY_CLIENT_USERNAME="client_username_here"
$env:SPOTIPY_REDIRECT_URI="http://localhost:8080" $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: ### Create virtual environment, install dependencies, run tests:
```bash ```bash