From 65597b8adc9c0ad7acd6d414d84aa66ad4097294 Mon Sep 17 00:00:00 2001 From: gubaidulinvadim Date: Fri, 28 Nov 2025 14:38:54 +0100 Subject: [PATCH] Updated CONTRIBUTING and README --- CONTRIBUTING.md | 3 +++ README.md | 11 +++++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b9f44446..d6374747 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,6 +17,9 @@ Thank you for your interest in contributing to [PyAML]! This document outlines h ### 3. Submitting Changes - **Fork & Branch:** Fork the repo and create a branch for your changes. - **Commits:** Write clear, atomic commit messages. Reference the issue number if applicable. +- **Formatting:** Ensure your code adheres to the project’s style guidelines. Run tests locally before submitting. It is recommended to use `pre-commit` hooks for this purpose. +Sometimes pre-commit hook will block you committing due to formatting issues. They may be fixed automatically or require manual intervention. If they are fixed automatically just re-stage the files and commit again. +If manual intervention is required, please follow the instructions provided by the pre-commit tool. - **Pull Requests (PRs):** - Open a PR against the `main` branch. - Include a description of your changes and reference the relevant issue. diff --git a/README.md b/README.md index b20ecc39..a44b2212 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,17 @@ Disclaimer: the pyAML software is still under development. cd pyaml pip install -e . ``` -4. If you want to try the examples using the TANGO bindings you also need [tango-pyaml](https://github.com/python-accelerator-middle-layer/tango-pyaml). + +4. For developers: install the development dependencies and pre-commit hooks + + ``` + pip install -e .[dev] + pre-commit install + ``` +5. If you want to try the examples using the TANGO bindings you also need [tango-pyaml](https://github.com/python-accelerator-middle-layer/tango-pyaml). Clone that repository and install the package inside the same virtual environment as the `pyaml` package. tango-pyaml will automatically install pyaml, so step 3 can be skipped. -5. For tests, you may want to install dummy-cs/tango available in +6. For tests, you may want to install dummy-cs/tango available in tests/dummy-cs/tango #### Documentation