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
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+36-7
Original file line number
Diff line number
Diff line change
@@ -33,19 +33,17 @@ However you choose to contribute, please be mindful and respect our
33
33
34
34
There are several ways you can contribute to smolagents.
35
35
36
-
* Fix outstanding issues with the existing code.
37
36
* Submit issues related to bugs or desired new features.
38
37
* Contribute to the examples or to the documentation.
38
+
* Fix outstanding issues with the existing code.
39
39
40
40
> All contributions are equally valuable to the community. 🥰
41
41
42
-
## Fixing outstanding issues
43
-
44
-
If you notice an issue with the existing code and have a fix in mind, feel free to [start contributing](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) and open
45
-
a Pull Request!
46
-
47
42
## Submitting a bug-related issue or feature request
48
43
44
+
At any moment, feel welcome to open an issue, citing your exact error traces and package versions if it's a bug.
45
+
It's often even better to open a PR with your proposed fixes/changes!
46
+
49
47
Do your best to follow these guidelines when submitting a bug-related issue or a feature
50
48
request. It will make it easier for us to come back to you quickly and with good
51
49
feedback.
@@ -89,10 +87,41 @@ We're always looking for improvements to the documentation that make it more cle
89
87
how the documentation can be improved such as typos and any content that is missing, unclear or inaccurate. We'll be
90
88
happy to make the changes or help you make a contribution if you're interested!
91
89
90
+
## Fixing outstanding issues
91
+
92
+
If you notice an issue with the existing code and have a fix in mind, feel free to [start contributing](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) and open
93
+
a Pull Request!
94
+
95
+
### Making code changes
96
+
97
+
To install dev dependencies, run:
98
+
```
99
+
pip install -e ".[dev]"
100
+
```
101
+
102
+
When making changes to the codebase, please check that it follows the repo's code quality requirements by running:
103
+
To check code quality of the source code:
104
+
```
105
+
make quality
106
+
```
107
+
108
+
If the checks fail, you can run the formatter with:
109
+
```
110
+
make style
111
+
```
112
+
113
+
And commit the changes.
114
+
115
+
To run tests locally, run this command:
116
+
```bash
117
+
make test
118
+
```
119
+
</details>
120
+
92
121
## I want to become a maintainer of the project. How do I get there?
93
122
94
123
smolagents is a project led and managed by Hugging Face. We are more than
95
124
happy to have motivated individuals from other organizations join us as maintainers with the goal of helping smolagents
96
125
make a dent in the world of Agents.
97
126
98
-
If you are such an individual (or organization), please reach out to us and let's collaborate.
127
+
If you are such an individual (or organization), please reach out to us and let's collaborate.
0 commit comments