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

Add CONTRIBUTING.MD #146

Closed
bcebere opened this issue Mar 8, 2023 · 2 comments · Fixed by #198
Closed

Add CONTRIBUTING.MD #146

bcebere opened this issue Mar 8, 2023 · 2 comments · Fixed by #198
Assignees

Comments

@bcebere
Copy link
Contributor

bcebere commented Mar 8, 2023

It should be clear for new contributors how to set their dev environment and how to run static checks locally before raising a PR.

This should also be added as a page at the top of README.md, for easy access.

The list should include:

  • creating a new conda/work env.
  • installing and running the pre-commit tools.
  • installing the dev depends using pip install synthcity[testing]
  • running the tests locally

Example from Opacus: https://github.com/pytorch/opacus/blob/main/CONTRIBUTING.md

@pravsels
Copy link
Contributor

pravsels commented Mar 27, 2023

I would find this very useful. I'm using a docker container locally and changes I make to the synthcity repository don't seem to be recompiling. I'm having to do a pip install . every time.

On Colab the pip install . flow is faster so that's how I'm doing it currently.

@bcebere
Copy link
Contributor Author

bcebere commented Mar 27, 2023

Hello @pravsels

You can use pip install -e . and you won't need to reinstall the library on every change. This installs the library in the editable mode.

@robsdavis robsdavis self-assigned this Apr 13, 2023
@robsdavis robsdavis linked a pull request May 22, 2023 that will close this issue
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 a pull request may close this issue.

3 participants