MirrorMirror
/
funkwhale
mirror of https://dev.funkwhale.audio/funkwhale/funkwhale.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add lint commands

This commit is contained in:
Ciarán Ainsworth 2022-10-13 16:37:06 +02:00 committed by Georg Krause
parent 2816d766da
commit 53a3e26e1c
1 changed files with 26 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
CONTRIBUTING.md
View File

@ -652,9 +652,32 @@ Funkwhale uses GitLab's merge requests to manage changes. The workflow looks lik
4. Create a new branch based on the checked out branch. Make sure to give your branch a meaningful name and include the issue number if required 4. Create a new branch based on the checked out branch. Make sure to give your branch a meaningful name and include the issue number if required
5. Work on your changes locally. Try to keep each commit small to make reviews easier 5. Work on your changes locally. Try to keep each commit small to make reviews easier
6. Add a changelog fragment summarizing your changes 6. Add a changelog fragment summarizing your changes
7. Push your branch 7. Lint the codebase using the following command:
8. Create a merge request in the GitLab frontend
9. We'll review your request and feed back ::::{tab-set}
:::{tab-item} API code
```sh
black --check --diff . # Run the black linter in the project root to highlight any new issues
```
:::
:::{tab-item} Frontend code
```sh
cd front
yarn run eslint # Run eslint in the front directory
```
:::
::::
8. Push your branch
9. Create a merge request in the GitLab frontend
10. We'll review your request and feed back
```{mermaid} ```{mermaid}
%%{init: { 'gitGraph': {'mainBranchName': 'stable'} } }%% %%{init: { 'gitGraph': {'mainBranchName': 'stable'} } }%%