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

Provide specific developer instructions for this repository #3

Open
redeboer opened this issue Apr 21, 2022 · 0 comments
Open

Provide specific developer instructions for this repository #3

redeboer opened this issue Apr 21, 2022 · 0 comments
Assignees
Labels
📝 Docs Improvements or additions to documentation

Comments

@redeboer
Copy link
Member

redeboer commented Apr 21, 2022

This repository has some peculiarities that not explained by the general develop page. Some things that need explaining (potentially on the general page as well):

  • What does environment.yml do, and where does it fetch (optional) pip dependencies and constraints
  • What is the first notebook cell in each notebook
  • Why are the pip install package==0.x.x statements needed
  • How best to work with cell metadata
  • How to 'freeze' cell output once a report is finished
  • How to store embed images in the notebooks without committing them to the repository (see this tip).
  • How to create GIF animations (see #129 (comment))
  • ...
@redeboer redeboer added the 📝 Docs Improvements or additions to documentation label Apr 21, 2022
@redeboer redeboer changed the title Add specific developer instructions for this repository Provide specific developer instructions for this repository Apr 26, 2022
@redeboer redeboer self-assigned this Apr 26, 2022
@redeboer redeboer transferred this issue from ComPWA/compwa.github.io Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 Docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant