You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit a7edf46
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+18-14Lines changed: 18 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ We welcome contributions to:
14
14
4. Submit a request for a new feature.
15
15
5. Improve our test coverage.
16
16
17
-
### Contributing Features
17
+
### Contributing Features ✨
18
18
19
19
Supervision is designed to provide generic utilities to solve problems. Thus, we focus on contributions that can have an impact on a wide range of projects.
This project utilizes the [pre-commit](https://pre-commit.com/) tool to maintain code quality and consistency. Before submitting a pull request or making any commits, it is important to run the pre-commit tool to ensure that your changes meet the project's guidelines.
52
56
57
+
Furthermore, we have integrated a pre-commit GitHub Action into our workflow. This means that with every pull request opened, the pre-commit checks will be automatically enforced, streamlining the code review process and ensuring that all contributions adhere to our quality standards.
58
+
53
59
To run the pre-commit tool, follow these steps:
54
60
55
61
1. Install pre-commit by running the following command: `poetry install`. It will not only install pre-commit but also install all the deps and dev-deps of project
@@ -60,6 +66,17 @@ To run the pre-commit tool, follow these steps:
60
66
61
67
4. You can also install pre-commit as a git hook by execute `pre-commit install`. Every time you made `git commit` pre-commit run automatically for you.
62
68
69
+
### Docstrings
70
+
71
+
All new functions and classes in `supervision` should include docstrings. This is a prerequisite for any new functions and classes to be added to the library.
72
+
73
+
`supervision` adheres to the [Google Python docstring style](https://google.github.io/styleguide/pyguide.html#383-functions-and-methods). Please refer to the style guide while writing docstrings for your contribution.
74
+
75
+
### Type checking
76
+
77
+
So far, **there is no type checking with mypy**. See [issue](https://github.com/roboflow-ai/template-python/issues/4).
78
+
79
+
63
80
Then, go back to your fork of the `supervision` repository, click "Pull Requests", and click "New Pull Request".
64
81
65
82

@@ -96,19 +113,6 @@ To run the documentation, install the project requirements with `poetry install
96
113
97
114
You can learn more about mkdocs on the [mkdocs website](https://www.mkdocs.org/).
98
115
99
-
## 🧹 code quality
100
-
101
-
We provide two handy commands inside the `Makefile`, namely:
102
-
103
-
-`make style` to format the code
104
-
-`make check_code_quality` to check code quality (PEP8 basically)
105
-
106
-
So far, **there is no type checking with mypy**. See [issue](https://github.com/roboflow-ai/template-python/issues/4).
107
-
108
-
All new functions and classes in `supervision` should include docstrings. This is a prerequisite for any new functions and classes to be added to the library.
109
-
110
-
`supervision` adheres to the [Google Python docstring style](https://google.github.io/styleguide/pyguide.html#383-functions-and-methods). Please refer to the style guide while writing docstrings for your contribution.
111
-
112
116
## 🧪 tests
113
117
114
118
[`pytests`](https://docs.pytest.org/en/7.1.x/) is used to run our tests.
0 commit comments