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

Document how to contribute #5

Closed
4 of 6 tasks
alvorithm opened this issue Mar 5, 2020 · 0 comments
Closed
4 of 6 tasks

Document how to contribute #5

alvorithm opened this issue Mar 5, 2020 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@alvorithm
Copy link

alvorithm commented Mar 5, 2020

  • Create a README.md
  • Explain how to install with conda and pip
  • Explain activation of nbstripout
  • For notebooks requiring output caching, explain use of git lfs.
  • Add badge for black - copy
    Code style: black
  • Further inspiration (wheels, etc) from thinc's README

See https://github.com/mackelab/sbi/blob/master/README.md for reference.

@alvorithm alvorithm self-assigned this Mar 5, 2020
@alvorithm alvorithm added the documentation Improvements or additions to documentation label Mar 5, 2020
janfb added a commit that referenced this issue Apr 12, 2024
janfb added a commit that referenced this issue Apr 12, 2024
@janfb janfb closed this as completed in e3acd58 Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant