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

DOC - Update contribution guidelines #69

Merged
merged 5 commits into from
Oct 23, 2024

Conversation

trallard
Copy link
Contributor

This PR follows #67 and adds some improvements

  • Add jupytext to requirements
  • Update gitignore
  • Update docs contribution guidelines

Looking at https://jax.readthedocs.io/en/latest/contributing.html, it might be worth adding similar instructions to set the dev environment and install pre-commit.

Also, perhaps we should link to these new docs from the top-level CONTRIBUTING.md

docs/contributing.md Outdated Show resolved Hide resolved
docs/contributing.md Outdated Show resolved Hide resolved
docs/requirements.txt Outdated Show resolved Hide resolved
Copy link
Collaborator

@jakevdp jakevdp left a comment

Choose a reason for hiding this comment

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

Looks great, thanks!

@jakevdp jakevdp merged commit fc8336d into jax-ml:main Oct 23, 2024
6 checks passed
@trallard trallard deleted the trallard/update-contrib-guides branch November 27, 2024 19:49
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