Merge pull request #86 from python-accelerator-middle-layer/update-readme-contributing

Updated CONTRIBUTING and README

Author: gubaidulinvadim

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.

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