Skip to content

Commit 72ed3fd

Browse files
Move contributing details into contributing file (huggingface#651)
1 parent 530e405 commit 72ed3fd

File tree

2 files changed

+37
-35
lines changed

2 files changed

+37
-35
lines changed

CONTRIBUTING.md

+36-7
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,17 @@ However you choose to contribute, please be mindful and respect our
3333

3434
There are several ways you can contribute to smolagents.
3535

36-
* Fix outstanding issues with the existing code.
3736
* Submit issues related to bugs or desired new features.
3837
* Contribute to the examples or to the documentation.
38+
* Fix outstanding issues with the existing code.
3939

4040
> All contributions are equally valuable to the community. 🥰
4141
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-
4742
## Submitting a bug-related issue or feature request
4843

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+
4947
Do your best to follow these guidelines when submitting a bug-related issue or a feature
5048
request. It will make it easier for us to come back to you quickly and with good
5149
feedback.
@@ -89,10 +87,41 @@ We're always looking for improvements to the documentation that make it more cle
8987
how the documentation can be improved such as typos and any content that is missing, unclear or inaccurate. We'll be
9088
happy to make the changes or help you make a contribution if you're interested!
9189

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+
92121
## I want to become a maintainer of the project. How do I get there?
93122

94123
smolagents is a project led and managed by Hugging Face. We are more than
95124
happy to have motivated individuals from other organizations join us as maintainers with the goal of helping smolagents
96125
make a dent in the world of Agents.
97126

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.

README.md

+1-28
Original file line numberDiff line numberDiff line change
@@ -226,34 +226,7 @@ This comparison shows that open-source models can now take on the best closed mo
226226

227227
## Contribute
228228

229-
To contribute, follow our [contribution guide](https://github.com/huggingface/smolagents/blob/main/CONTRIBUTING.md).
230-
231-
At any moment, feel welcome to open an issue, citing your exact error traces and package versions if it's a bug.
232-
It's often even better to open a PR with your proposed fixes/changes!
233-
234-
To install dev dependencies, run:
235-
```
236-
pip install -e ".[dev]"
237-
```
238-
239-
When making changes to the codebase, please check that it follows the repo's code quality requirements by running:
240-
To check code quality of the source code:
241-
```
242-
make quality
243-
```
244-
245-
If the checks fail, you can run the formatter with:
246-
```
247-
make style
248-
```
249-
250-
And commit the changes.
251-
252-
To run tests locally, run this command:
253-
```bash
254-
make test
255-
```
256-
</details>
229+
Everyone is welcome to contribute, get started with our [contribution guide](https://github.com/huggingface/smolagents/blob/main/CONTRIBUTING.md).
257230

258231
## Cite smolagents
259232

0 commit comments

Comments
 (0)