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

Improving the section on how to contribute #1130

Open
6 tasks
rcap107 opened this issue Oct 28, 2024 · 1 comment
Open
6 tasks

Improving the section on how to contribute #1130

rcap107 opened this issue Oct 28, 2024 · 1 comment
Labels
documentation Add or improve the documentation no changelog needed

Comments

@rcap107
Copy link
Contributor

rcap107 commented Oct 28, 2024

Describe the issue linked to the documentation

Hello, while I was working on my first PR I hit a few snags and problems that may also happen to new contributors, so I thought it might be useful to update the section in the documentation relative to contributing to skrub.

Some of the things I would like to add:

  • A checklist of the operations that should be performed for the PR (pre-commit, write tests, update the changelog etc.)
  • How to run tests using a specific environment with pixi on the local machine for debugging
  • How to check for code coverage on the local machine
  • How to check doctests
  • Preparing and running pre-commit
  • Some information on where the code for testing is, and how to structure tests

If you have more ideas, please add them!

@Vincent-Maladiere suggested having a section on working with pixi, but I don't have enough experience with it to write it.

Suggest a potential alternative/fix

No response

@rcap107 rcap107 added documentation Add or improve the documentation no changelog needed labels Oct 28, 2024
@jeromedockes
Copy link
Member

thanks @rcap107 that's a great idea. I guess this is the file to update: https://github.com/skrub-data/skrub/blob/main/CONTRIBUTING.rst

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Add or improve the documentation no changelog needed
Projects
None yet
Development

No branches or pull requests

2 participants