Skip to content

Commit 754cddf

Browse files
committed
Add code of conduct and contributing guide
1 parent e57f4f5 commit 754cddf

File tree

3 files changed

+233
-2
lines changed

3 files changed

+233
-2
lines changed

.gitignore

+2-2
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ dmypy.json
139139
cython_debug/
140140

141141
# PyCharm
142-
#.idea/
142+
.idea/
143143

144144
# Interpreter
145145
interpreter_workspace/
@@ -148,4 +148,4 @@ interpreter_workspace/
148148
archive/
149149
savedir/
150150
output/
151-
tool_output/
151+
tool_output/

CODE_OF_CONDUCT.md

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, caste, color, religion, or sexual
11+
identity and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the overall
27+
community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or advances of
32+
any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email address,
36+
without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official e-mail address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series of
87+
actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or permanent
94+
ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within the
114+
community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.1, available at
120+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
127+
[https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
<!---
2+
Copyright 2025 The HuggingFace Team. All rights reserved.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
-->
16+
17+
# Contribute to smolagents
18+
19+
Everyone is welcome to contribute, and we value everybody's contribution. Code
20+
contributions are not the only way to help the community. Answering questions, helping
21+
others, and improving the documentation are also immensely valuable.
22+
23+
It also helps us if you spread the word! Reference the library in blog posts
24+
about the awesome projects it made possible, shout out on Twitter every time it has
25+
helped you, or simply ⭐️ the repository to say thank you.
26+
27+
However you choose to contribute, please be mindful and respect our
28+
[code of conduct](https://github.com/huggingface/smolagents/blob/main/CODE_OF_CONDUCT.md).
29+
30+
**This guide was heavily inspired by the awesome [scikit-learn guide to contributing](https://github.com/scikit-learn/scikit-learn/blob/main/CONTRIBUTING.md).**
31+
32+
## Ways to contribute
33+
34+
There are several ways you can contribute to smolagents.
35+
36+
* Fix outstanding issues with the existing code.
37+
* Submit issues related to bugs or desired new features.
38+
* Contribute to the examples or to the documentation.
39+
40+
> All contributions are equally valuable to the community. 🥰
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+
## Submitting a bug-related issue or feature request
48+
49+
Do your best to follow these guidelines when submitting a bug-related issue or a feature
50+
request. It will make it easier for us to come back to you quickly and with good
51+
feedback.
52+
53+
### Did you find a bug?
54+
55+
The smolagents library is robust and reliable thanks to users who report the problems they encounter.
56+
57+
Before you report an issue, we would really appreciate it if you could **make sure the bug was not
58+
already reported** (use the search bar on GitHub under Issues). Your issue should also be related to bugs in the
59+
library itself, and not your code.
60+
61+
Once you've confirmed the bug hasn't already been reported, please include the following information in your issue so
62+
we can quickly resolve it:
63+
64+
* Your **OS type and version**, as well as your environment versions (versions of rust, python, and dependencies).
65+
* A short, self-contained, code snippet that allows us to reproduce the bug.
66+
* The *full* traceback if an exception is raised.
67+
* Attach any other additional information, like screenshots, you think may help.
68+
69+
### Do you want a new feature?
70+
71+
If there is a new feature you'd like to see in smolagents, please open an issue and describe:
72+
73+
1. What is the *motivation* behind this feature? Is it related to a problem or frustration with the library? Is it
74+
a feature related to something you need for a project? Is it something you worked on and think it could benefit
75+
the community?
76+
77+
Whatever it is, we'd love to hear about it!
78+
79+
2. Describe your requested feature in as much detail as possible. The more you can tell us about it, the better
80+
we'll be able to help you.
81+
3. Provide a *code snippet* that demonstrates the feature's usage.
82+
4. If the feature is related to a paper, please include a link.
83+
84+
If your issue is well written we're already 80% of the way there by the time you create it.
85+
86+
## Do you want to add documentation?
87+
88+
We're always looking for improvements to the documentation that make it more clear and accurate. Please let us know
89+
how the documentation can be improved such as typos and any content that is missing, unclear or inaccurate. We'll be
90+
happy to make the changes or help you make a contribution if you're interested!
91+
92+
## I want to become a maintainer of the project. How do I get there?
93+
94+
Smolagents is a project led and managed by Hugging Face as an initial fork of Transformers Agents. We are more than
95+
happy to have motivated individuals from other organizations join us as maintainers with the goal of helping Smolagents
96+
make a dent in the world of Agents.
97+
98+
If you are such an individual (or organization), please reach out to us and let's collaborate.

0 commit comments

Comments
 (0)