diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0e346b751..f63be4fcc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,19 +33,17 @@ However you choose to contribute, please be mindful and respect our There are several ways you can contribute to smolagents. -* Fix outstanding issues with the existing code. * Submit issues related to bugs or desired new features. * Contribute to the examples or to the documentation. +* Fix outstanding issues with the existing code. > All contributions are equally valuable to the community. 🥰 -## Fixing outstanding issues - -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 -a Pull Request! - ## Submitting a bug-related issue or feature request +At any moment, feel welcome to open an issue, citing your exact error traces and package versions if it's a bug. +It's often even better to open a PR with your proposed fixes/changes! + Do your best to follow these guidelines when submitting a bug-related issue or a feature request. It will make it easier for us to come back to you quickly and with good feedback. @@ -89,10 +87,41 @@ We're always looking for improvements to the documentation that make it more cle how the documentation can be improved such as typos and any content that is missing, unclear or inaccurate. We'll be happy to make the changes or help you make a contribution if you're interested! +## Fixing outstanding issues + +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 +a Pull Request! + +### Making code changes + +To install dev dependencies, run: +``` +pip install -e ".[dev]" +``` + +When making changes to the codebase, please check that it follows the repo's code quality requirements by running: +To check code quality of the source code: +``` +make quality +``` + +If the checks fail, you can run the formatter with: +``` +make style +``` + +And commit the changes. + +To run tests locally, run this command: +```bash +make test +``` + + ## I want to become a maintainer of the project. How do I get there? smolagents is a project led and managed by Hugging Face. We are more than happy to have motivated individuals from other organizations join us as maintainers with the goal of helping smolagents make a dent in the world of Agents. -If you are such an individual (or organization), please reach out to us and let's collaborate. \ No newline at end of file +If you are such an individual (or organization), please reach out to us and let's collaborate. diff --git a/README.md b/README.md index 0191e7963..79551f013 100644 --- a/README.md +++ b/README.md @@ -226,34 +226,7 @@ This comparison shows that open-source models can now take on the best closed mo ## Contribute -To contribute, follow our [contribution guide](https://github.com/huggingface/smolagents/blob/main/CONTRIBUTING.md). - -At any moment, feel welcome to open an issue, citing your exact error traces and package versions if it's a bug. -It's often even better to open a PR with your proposed fixes/changes! - -To install dev dependencies, run: -``` -pip install -e ".[dev]" -``` - -When making changes to the codebase, please check that it follows the repo's code quality requirements by running: -To check code quality of the source code: -``` -make quality -``` - -If the checks fail, you can run the formatter with: -``` -make style -``` - -And commit the changes. - -To run tests locally, run this command: -```bash -make test -``` - +Everyone is welcome to contribute, get started with our [contribution guide](https://github.com/huggingface/smolagents/blob/main/CONTRIBUTING.md). ## Cite smolagents