Skip to content

Updated the Documentation as Pre-Commit addition into codebase #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 14, 2024
Merged

Updated the Documentation as Pre-Commit addition into codebase #79

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a373975
Update README.md
IamMQaisar Mar 13, 2024
d13463f
Update README.md
IamMQaisar Mar 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,16 @@ follow these steps:

It will run on every commit automatically.

### pre-commit Configuration

A `.pre-commit-config.yaml` file has been added to the repository. This configuration file defines hooks to maintain code quality and formatting standards. These hooks are automatically executed before each commit to ensure consistency across the codebase. They include:

- **Black**: A code formatter for Python.
- **Flake8**: A tool that checks Python code for style and quality.
- **isort**: A utility for sorting and formatting Python imports.

The configuration ensures that the codebase adheres to consistent formatting and style guidelines, enhancing readability and maintainability.

#### Using [`dev/tools.sh`][tools-sh] helper script
The [`dev/tools.sh`][tools-sh] helper script runs the static analysis tools
(`black`, `flake8`, and `isort`):
Expand Down Expand Up @@ -126,7 +136,7 @@ directories to check:

[ccospyguide]: https://opensource.creativecommons.org/contributing-code/python-guidelines/
[black]: https://github.com/psf/black
[flake8]: https://gitlab.com/pycqa/flake8
[flake8]: https://github.com/PyCQA/flake8
[isort]: https://pycqa.github.io/isort/
[pipenv]: https://github.com/pypa/pipenv
[pre-commit]: https://pre-commit.com/
Expand Down Expand Up @@ -174,7 +184,6 @@ The data within this repository is dedicated to the public domain under the
[cc-zero-png]: https://licensebuttons.net/l/zero/1.0/88x31.png "CC0 1.0 Universal (CC0 1.0) Public Domain Dedication button"
[cc-zero]: https://creativecommons.org/publicdomain/zero/1.0/


### Documentation

[![CC BY 4.0 license button][cc-by-png]][cc-by]
Expand Down