From 5d519ebda3db4583dd6da1a84c49ade4e873c880 Mon Sep 17 00:00:00 2001 From: simon Date: Wed, 22 Sep 2021 12:18:54 +0700 Subject: [PATCH] added section about formatting and linting --- CONTRIBUTING.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 97cd857..6b91575 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,4 +14,14 @@ To fix a bug or implement a feature, fork the repository and make all changes to ## Releases -Everything on the master branch is what's in the latest release and is what you get in your container when you `pull` either the *:latest* tag or the newest named version. If you want to test the newest changes and improvements, clone the repository and build the docker container with the Dockerfile from the testing branch. \ No newline at end of file +Everything on the master branch is what's in the latest release and is what you get in your container when you `pull` either the *:latest* tag or the newest named version. If you want to test the newest changes and improvements, clone the repository and build the docker container with the Dockerfile from the testing branch. + +## Code formatting and linting + +To keep things clean and consistent for everybody, there is a github action setup to lint and check the changes. You can test your code locally first if you want. For example if you made changes in the **download** module, run + +```shell +./deploy.sh validate tubearchivist/home/src/download.py +``` + +to validate your changes. If you omit the path, all the project files will get checked. This is subject to change as the codebase improves. \ No newline at end of file