Skip to content

Move contributing details into contributing file #651

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

GrahamTheCoder
Copy link
Contributor

@GrahamTheCoder GrahamTheCoder commented Feb 14, 2025

This is where I looked at least. I've kept the existing text I've moved exactly the same.

CONTRIBUTING.md Outdated
@@ -83,6 +86,32 @@ If there is a new feature you'd like to see in smolagents, please open an issue

If your issue is well written we're already 80% of the way there by the time you create it.

### Code changes
Copy link
Contributor Author

@GrahamTheCoder GrahamTheCoder Feb 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This title is added, everything else in this file is existing text

Copy link
Member

@albertvillanova albertvillanova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Good to have all the info in the Contributing guideline.

Wouldn't it make more sense to put this addition under

  • "Fixing outstanding issues" section

instead of under:

  • "Submitting a bug-related issue or feature request" section?

@GrahamTheCoder
Copy link
Contributor Author

Yeah I agree it makes more sense. I was slightly worried about putting code blocks before the bit that non-coders should read.
Might be ok since it's clearly titled, or we could reorder the sections?

Copy link
Member

@albertvillanova albertvillanova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you again! I totally agree: I think it would be better to sort the sections from lower to higher complexity.

What about this order?

  ## Ways to contribute

  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.

Doesn't change any text content, just ordering
@GrahamTheCoder
Copy link
Contributor Author

Great, that's hopefully now an improvement for all types of contributor

Copy link
Member

@albertvillanova albertvillanova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!! Much clearer now!

@albertvillanova albertvillanova merged commit 72ed3fd into huggingface:main Feb 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants