📚 Update contribution guidelines

CONTRIBUTING.md

@@ -12,7 +12,7 @@ We want to make it as simple and straightforward as possible to contribute to th
 
 ## Bug Report
 
-We use GitHub issues to track the bugs. Report a bug by using our Bug Report Template in [Issues](https://github.com/openvinotoolkit/anomalib/issues/new?assignees=&labels=&template=bug_report.md).
+We use GitHub issues to track the bugs. Report a bug by using our Bug Report Template in [Issues](https://github.com/openvinotoolkit/anomalib/issues/new?assignees=&labels=&projects=&template=bug_report.yaml&title=%5BBug%5D%3A+).
 
 ## Discussion
 
@@ -26,50 +26,101 @@ We utilize GitHub issues to track the feature requests as well. If you are certa
 
 We actively welcome your pull requests:
 
-1. Fork the repo and create your branch from [`main`](https://github.com/openvinotoolkit/anomalib/tree/main).
-1. Set up the development environment by following the instructions below.
-1. If you've added code that should be tested, add tests.
-1. If you've changed APIs, update the documentation.
-1. Ensure the test suite passes.
-1. Make sure you own the code you're submitting or that you obtain it from a source with an appropriate license.
-1. Add a summary of the changes to the [CHANGELOG](https://github.com/openvinotoolkit/anomalib/blob/main/CHANGELOG.md) (not for minor changes, docs and tests).
-1. Issue that pull request!
+###  Getting Started
 
-### Setting up the development environment and using pre-commit
+#### 1. Fork and Clone the Repository
 
-To setup the development environment, you will need to install development requirements, as well as the base requirements of the library.
+First, fork the Anomalib repository by following the GitHub documentation on [forking a repo](https://docs.github.com/en/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo). Then, clone your forked repository to your local machine and create a new branch from `main`.
 
-```bash
-conda create -n anomalib_dev python=3.10
-conda activate anomalib_dev
-pip install -r requirements/base.txt -r requirements/dev.txt
-pre-commit install
-```
+#### 2. Set Up Your Development Environment
+
+Set up your development environment to start contributing. This involves installing the required dependencies and setting up pre-commit hooks for code quality checks. Note that this guide assumes you are using [Conda](https://docs.conda.io/en/latest/) for package management. However, the steps are similar for other package managers.
+
+<details>
+<summary>Development Environment Setup Instructions</summary>
+
+1. Create and activate a new Conda environment:
+
+   ```bash
+   conda create -n anomalib_dev python=3.10
+   conda activate anomalib_dev
+   ```
+
+2. Install the base and development requirements:
 
-The commands above will install pre-commit. Pre-commit hooks will run each of the code quality tools listed above each time you commit some changes to a branch. Some tools like black and isort will automatically format your files to enforce consistent formatting within the repo. Other tools will provide a list of errors and warnings which you will be required to address before being able to make the commit.
+   ```bash
+   pip install -r requirements/base.txt -r requirements/dev.txt
+   ```
 
-The pre-commit checks can also be triggered manually with the following command:
+   Optionally, for a full installation with all dependencies:
+
+   ```bash
+   pip install -e .[all]
+   ```
+
+3. Install and configure pre-commit hooks:
+
+   ```bash
+   pre-commit install
+   ```
+
+Pre-commit hooks help ensure code quality and consistency. After each commit,
+`pre-commit` will automatically run the configured checks for the changed file.
+If you would like to manually run the checks for all files, use:
 
 ```bash
 pre-commit run --all-files
 ```
 
-In some cases it might be desired to commit your changes even though some of the checks are failing. For example when you want to address the pre-commit issues at a later time, or when you want to commit a work-in-progress. In these cases, you can skip the pre-commit hooks by adding the `--no-verify` parameter to the commit command.
+To bypass pre-commit hooks temporarily (e.g., for a work-in-progress commit),
+use:
 
 ```bash
 git commit -m 'WIP commit' --no-verify
 ```
 
-When doing so, please make sure to revisit the pre-commit issues before you submit your PR. A good way to confirm if your code passes the checks is by running `pre-commit run --all-files`.
+However, make sure to address any pre-commit issues before finalizing your pull request.
 
-More information on pre-commit and how it is used in Anomalib can be found in our documentation:
+</details>
 
-- [Pre-commit hooks guide](https://openvinotoolkit.github.io/anomalib/developer_guide/pre_commit_hooks.html)
+### Making Changes
 
-## License
+1. **Write Code:** Follow the project's coding standards and write your code with clear intent. Ensure your code is well-documented and includes examples where appropriate. For code quality we use ruff, whose configuration is in [`pyproject.toml`](https://github.com/openvinotoolkit/anomalib/blob/main/pyproject.toml) file.
 
-You accept that your contributions will be licensed under the [Apache-2.0 License](https://choosealicense.com/licenses/apache-2.0/) if you contribute to this repository. If this is a concern, please notify the maintainers.
+2. **Add Tests:** If your code includes new functionality, add corresponding tests using [pytest](https://docs.pytest.org/en/7.4.x/) to maintain coverage and reliability.
+
+3. **Update Documentation:** If you've changed APIs or added new features, update the documentation accordingly. Ensure your docstrings are clear and follow [Google's docstring guide](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings).
 
-## References
+4. **Pass Tests and Quality Checks:** Ensure the test suite passes and that your code meets quality standards by running:
 
-This document was adapted from [here](https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62).
+   ```bash
+   pre-commit run --all-files
+   pytest tests/
+   ```
+
+5. **Update the Changelog:** For significant changes, add a summary to the [CHANGELOG](https://github.com/openvinotoolkit/anomalib/blob/main/CHANGELOG.md).
+
+6. **Check Licensing:** Ensure you own the code or have rights to use it, adhering to appropriate licensing.
+
+7. **Sign Your Commits:** Use signed commits to certify that you have the right to submit the code under the project's license:
+
+   ```bash
+   git commit -S -m "Your detailed commit message"
+   ```
+
+   For more on signing commits, see [GitHub's guide on signing commits](https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification/signing-commits).
+
+### Submitting Pull Requests
+
+Once you've followed the above steps and are satisfied with your changes:
+
+1. Push your changes to your forked repository.
+2. Go to the original Anomalib repository you forked and click "New pull request".
+3. Choose your fork and the branch with your changes to open a pull request.
+4. Fill in the pull request template with the necessary details about your changes.
+
+We look forward to your contributions!
+
+## License
+
+You accept that your contributions will be licensed under the [Apache-2.0 License](https://choosealicense.com/licenses/apache-2.0/) if you contribute to this repository. If this is a concern, please notify the maintainers.

docs/source/index.md

@@ -52,7 +52,6 @@ Get started with anomalib in 15 minutes.
 ## {octicon}`book` Guides
 
 ::::{grid}
-:margin: 1 1 0 0
 :gutter: 1
 
 :::{grid-item-card} {octicon}`codescan` Reference Guide
@@ -62,20 +61,27 @@ Get started with anomalib in 15 minutes.
 Learn more about anomalib API and CLI.
 :::
 
-:::{grid-item-card} {octicon}`question` How-To Guides
+:::{grid-item-card} {octicon}`question` How-To Guide
 :link: markdown/guides/how_to/index
 :link-type: doc
 
 Learn how to use anomalib for your anomaly detection tasks.
 :::
 
-:::{grid-item-card} {octicon}`telescope` Topic Guides
+:::{grid-item-card} {octicon}`telescope` Topic Guide
 :link: markdown/guides/topic/index
 :link-type: doc
 
 Learn more about the internals of anomalib.
 :::
 
+:::{grid-item-card} {octicon}`code` Developer Guide
+:link: markdown/guides/developer/index
+:link-type: doc
+
+Learn how to develop and contribute to anomalib.
+:::
+
 ::::
 
 ```{toctree}
@@ -92,4 +98,5 @@ markdown/get_started/anomalib
 markdown/guides/reference/index
 markdown/guides/how_to/index
 markdown/guides/topic/index
+markdown/guides/developer/index
 ```

docs/source/markdown/guides/developer/index.md

@@ -0,0 +1,99 @@
+# Developer Guide
+
+This section contains information for developers who want to contribute to Anomalib.
+
+##  {octicon}`light-bulb` Getting Started
+
+To get started with Anomalib development, follow these steps:
+
+### {octicon}`repo-forked` Fork and Clone the Repository
+
+First, fork the Anomalib repository by following the GitHub documentation on [forking a repo](https://docs.github.com/en/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo). Then, clone your forked repository to your local machine and create a new branch from `main`.
+
+### {octicon}`gear` Set Up Your Development Environment
+
+Set up your development environment to start contributing. This involves installing the required dependencies and setting up pre-commit hooks for code quality checks. Note that this guide assumes you are using [Conda](https://docs.conda.io/en/latest/) for package management. However, the steps are similar for other package managers.
+
+:::{dropdown} Development Environment Setup Instructions
+:icon: gear
+
+1. Create and activate a new Conda environment:
+
+   ```bash
+   conda create -n anomalib_dev python=3.10
+   conda activate anomalib_dev
+   ```
+
+   Install the base and development requirements:
+
+   ```bash
+   pip install -r requirements/base.txt -r requirements/dev.txt
+   ```
+
+   Optionally, for a full installation with all dependencies:
+
+   ```bash
+   pip install -e .[all]
+   ```
+
+2. Install and configure pre-commit hooks:
+
+   ```bash
+   pre-commit install
+   ```
+
+   Pre-commit hooks help ensure code quality and consistency. After each commit,
+   `pre-commit` will automatically run the configured checks for the changed file.
+   If you would like to manually run the checks for all files, use:
+
+   ```bash
+   pre-commit run --all-files
+   ```
+
+   To bypass pre-commit hooks temporarily (e.g., for a work-in-progress commit), use:
+
+   ```bash
+   git commit -m 'WIP commit' --no-verify
+   ```
+
+   However, make sure to address any pre-commit issues before finalizing your pull request.
+
+:::
+
+## {octicon}`diff` Making Changes
+
+1. **Write Code:** Follow the project's coding standards and write your code with clear intent. Ensure your code is well-documented and includes examples where appropriate. For code quality we use ruff, whose configuration is in [`pyproject.toml`](https://github.com/openvinotoolkit/anomalib/blob/main/pyproject.toml) file.
+
+2. **Add Tests:** If your code includes new functionality, add corresponding tests using [pytest](https://docs.pytest.org/en/7.4.x/) to maintain coverage and reliability.
+
+3. **Update Documentation:** If you've changed APIs or added new features, update the documentation accordingly. Ensure your docstrings are clear and follow [Google's docstring guide](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings).
+
+4. **Pass Tests and Quality Checks:** Ensure the test suite passes and that your code meets quality standards by running:
+
+   ```bash
+   pre-commit run --all-files
+   pytest tests/
+   ```
+
+5. **Update the Changelog:** For significant changes, add a summary to the [CHANGELOG](https://github.com/openvinotoolkit/anomalib/blob/main/CHANGELOG.md).
+
+6. **Check Licensing:** Ensure you own the code or have rights to use it, adhering to appropriate licensing.
+
+7. **Sign Your Commits:** Use signed commits to certify that you have the right to submit the code under the project's license:
+
+   ```bash
+   git commit -S -m "Your detailed commit message"
+   ```
+
+   For more on signing commits, see [GitHub's guide on signing commits](https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification/signing-commits).
+
+## {octicon}`git-pull-request` Submitting Pull Requests
+
+Once you've followed the above steps and are satisfied with your changes:
+
+1. Push your changes to your forked repository.
+2. Go to the original Anomalib repository you forked and click "New pull request".
+3. Choose your fork and the branch with your changes to open a pull request.
+4. Fill in the pull request template with the necessary details about your changes.
+
+We look forward to your contributions!