Skip to content

Update the contributing style guide #1795

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
Feb 5, 2024
Merged

Update the contributing style guide #1795

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d9504ae
Update the contributing style guide
mattbit Feb 5, 2024
f71cdf4
Merge branch 'main' into task/update-contrib-guide
Hartorn Feb 5, 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
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ An awesome feature request addresses the following points:

## Style guide

For documentation strings, Giskard follows the [google style](https://google.github.io/styleguide/pyguide.html).
We use `black` to format the code and `isort` to sort the imports. You can automatically enforce this style using the pre-commit hooks. You can find the instructions to install the pre-commit hooks [here](https://docs.giskard.ai/en/latest/community/contribution_guidelines/dev-environment.html).

For documentation strings, Giskard follows the [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard) style.

**This guide was heavily inspired by the awesome [HuggingFace guide to contributing](https://github.com/huggingface/transformers/blob/main/CONTRIBUTING.md).**