Skip to content
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

docs: Improve contributing #1303

Merged
merged 9 commits into from
Feb 11, 2025
Merged

docs: Improve contributing #1303

merged 9 commits into from
Feb 11, 2025

Conversation

MarieSacksick
Copy link
Contributor

@MarieSacksick MarieSacksick commented Feb 10, 2025

Closes #882

Add

  • say where people can get the logo --> I suggest we don't do it because there is no reason to add logos now.
  • say that images on README should not break in pypi --> cancelled for now as I don't see any constraint in their doc.
  • where to store large files
  • what files can be modified when tackling examples
  • say how to run the tests (whether only back or front)
  • for the UI, say sometimes must do hard refresh -> UI, dark mode: the name of items doesn't appear well #1011 (comment)
  • add a code of conduct

@MarieSacksick MarieSacksick marked this pull request as draft February 10, 2025 15:08
@MarieSacksick
Copy link
Contributor Author

say that images on README should not break in pypi

I didn't find any constraint specified in pypi doc, therefore I don't plan to add anything.

Copy link
Contributor

github-actions bot commented Feb 10, 2025

Documentation preview @ a2a352d

@MarieSacksick MarieSacksick marked this pull request as ready for review February 10, 2025 17:22
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@auguste-probabl auguste-probabl left a comment

Choose a reason for hiding this comment

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

Great work, thanks! The "values" section is especially welcome. I added a few suggestions

MarieSacksick and others added 4 commits February 11, 2025 11:35
Co-authored-by: Auguste Baum <[email protected]>
Co-authored-by: Auguste Baum <[email protected]>
Co-authored-by: Auguste Baum <[email protected]>
Co-authored-by: Auguste Baum <[email protected]>
Copy link
Contributor

@auguste-probabl auguste-probabl left a comment

Choose a reason for hiding this comment

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

Thanks!

@auguste-probabl auguste-probabl merged commit e2515a9 into main Feb 11, 2025
7 checks passed
@auguste-probabl auguste-probabl deleted the contribution branch February 11, 2025 12:59
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.

fix(docs): Update the contributing guide
2 participants