From eb2778086f076ed8a8bc6a73bbb4601c3e9c9acd Mon Sep 17 00:00:00 2001 From: Georges-Antoine Assi Date: Sun, 2 Jun 2024 23:22:14 -0400 Subject: [PATCH] changes from self review --- CONTRIBUTING.md | 9 +++++---- DEVELOPER_SETUP.md | 19 +++++++++++++++++++ docker/Dockerfile | 2 +- poetry.lock | 18 +++++++++--------- 4 files changed, 34 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 21d56ccac..973ccfbcc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,10 +17,11 @@ If you would like to contribute to the project's [documentation](https://github. 1. Fork the repository. 2. Clone your forked repository: `git clone https://github.com/your-username/romm.git` 3. Checkout the `master` branch: `git checkout master` -4. Create a new branch for your feature/fix: `git checkout -b feature-or-fix-name` -5. Make your changes and commit them with descriptive commit messages: `git commit -am 'Add feature XYZ'` -6. Push your changes to your fork: `git push origin feature-or-fix-name` -7. Open a pull request to the `master` branch of the original repository. +4. Follow the steps in the [developer setup guide](DEVELOPER_SETUP.md) +5. Create a new branch for your feature/fix: `git checkout -b feature-or-fix-name` +6. Make your changes and commit them with descriptive commit messages: `git commit -am 'Add feature XYZ'` +7. Push your changes to your fork: `git push origin feature-or-fix-name` +8. Open a pull request to the `master` branch of the original repository. ### Pull Request Guidelines diff --git a/DEVELOPER_SETUP.md b/DEVELOPER_SETUP.md index abbe81657..3f16d2d69 100644 --- a/DEVELOPER_SETUP.md +++ b/DEVELOPER_SETUP.md @@ -96,6 +96,25 @@ ln -s ../backend/romm_mock/assets assets/romm/assets npm run dev ``` +## Setting up the linter + +We use [Trunk](https://trunk.io) for linting, which combines multiple linters and formatters with sensible defaults and a single configuration file. You'll need to install the Trunk CLI to use it. + +### - Install the Trunk CLI + +```sh +curl https://get.trunk.io -fsSL | bash +``` + +Alternative installation methods can be found [here](https://docs.trunk.io/check/usage#install-the-cli). On commit, the linter will run automatically. To run it manually, use the following commands: + +```sh +trunk fmt +trunk check +``` + +**Failing to install and run the linter will result in a failed CI check, which won't allow us to merge your PR.** + # Test setup ### - Create the test user and database with root user diff --git a/docker/Dockerfile b/docker/Dockerfile index 17088270a..a03f7315a 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -10,7 +10,7 @@ ENV REDIS_VERSION 7.2.4 ENV REDIS_DOWNLOAD_URL http://download.redis.io/releases/redis-7.2.4.tar.gz ENV REDIS_DOWNLOAD_SHA 8d104c26a154b29fd67d6568b4f375212212ad41e0c2caa3d66480e78dbd3b59 -RUN wget --no-cache -O redis.tar.gz "$REDIS_DOWNLOAD_URL"; \ +RUN wget -O redis.tar.gz "$REDIS_DOWNLOAD_URL"; \ echo "$REDIS_DOWNLOAD_SHA *redis.tar.gz" | sha256sum -c -; \ mkdir -p /usr/src/redis; \ tar -xzf redis.tar.gz -C /usr/src/redis --strip-components=1; \ diff --git a/poetry.lock b/poetry.lock index 0c8b96cf2..e590e8a92 100644 --- a/poetry.lock +++ b/poetry.lock @@ -150,13 +150,13 @@ files = [ [[package]] name = "certifi" -version = "2024.2.2" +version = "2024.6.2" description = "Python package for providing Mozilla's CA Bundle." optional = false python-versions = ">=3.6" files = [ - {file = "certifi-2024.2.2-py3-none-any.whl", hash = "sha256:dc383c07b76109f368f6106eee2b593b04a011ea4d55f652c6ca24a754d1cdd1"}, - {file = "certifi-2024.2.2.tar.gz", hash = "sha256:0569859f95fc761b18b45ef421b1290a0f65f147e92a1e5eb3e635f9a5e4e66f"}, + {file = "certifi-2024.6.2-py3-none-any.whl", hash = "sha256:ddc6c8ce995e6987e7faf5e3f1b02b302836a0e5d98ece18392cb1a36c72ad56"}, + {file = "certifi-2024.6.2.tar.gz", hash = "sha256:3cd43f1c6fa7dedc5899d69d3ad0398fd018ad1a17fba83ddaf78aa46c747516"}, ] [[package]] @@ -2054,13 +2054,13 @@ types-pyOpenSSL = "*" [[package]] name = "types-requests" -version = "2.32.0.20240523" +version = "2.32.0.20240602" description = "Typing stubs for requests" optional = false python-versions = ">=3.8" files = [ - {file = "types-requests-2.32.0.20240523.tar.gz", hash = "sha256:26b8a6de32d9f561192b9942b41c0ab2d8010df5677ca8aa146289d11d505f57"}, - {file = "types_requests-2.32.0.20240523-py3-none-any.whl", hash = "sha256:f19ed0e2daa74302069bbbbf9e82902854ffa780bc790742a810a9aaa52f65ec"}, + {file = "types-requests-2.32.0.20240602.tar.gz", hash = "sha256:3f98d7bbd0dd94ebd10ff43a7fbe20c3b8528acace6d8efafef0b6a184793f06"}, + {file = "types_requests-2.32.0.20240602-py3-none-any.whl", hash = "sha256:ed3946063ea9fbc6b5fc0c44fa279188bae42d582cb63760be6cb4b9d06c3de8"}, ] [package.dependencies] @@ -2079,13 +2079,13 @@ files = [ [[package]] name = "typing-extensions" -version = "4.12.0" +version = "4.12.1" description = "Backported and Experimental Type Hints for Python 3.8+" optional = false python-versions = ">=3.8" files = [ - {file = "typing_extensions-4.12.0-py3-none-any.whl", hash = "sha256:b349c66bea9016ac22978d800cfff206d5f9816951f12a7d0ec5578b0a819594"}, - {file = "typing_extensions-4.12.0.tar.gz", hash = "sha256:8cbcdc8606ebcb0d95453ad7dc5065e6237b6aa230a31e81d0f440c30fed5fd8"}, + {file = "typing_extensions-4.12.1-py3-none-any.whl", hash = "sha256:6024b58b69089e5a89c347397254e35f1bf02a907728ec7fee9bf0fe837d203a"}, + {file = "typing_extensions-4.12.1.tar.gz", hash = "sha256:915f5e35ff76f56588223f15fdd5938f9a1cf9195c0de25130c627e4d597f6d1"}, ] [[package]]