studio-lab-examples icon indicating copy to clipboard operation
studio-lab-examples copied to clipboard

Add description about environment to Contributing Guidelines

Open icoxfog417 opened this issue 2 years ago • 0 comments

Link to the document https://github.com/aws/studio-lab-examples/blob/main/CONTRIBUTING.md

What aspects of the notebook can be improved? For now, Contributing Guidelines does not mention about how to create the environment. For that reason, the way to prepare for the environment is different one by one.

What are your suggestions? We should mention about how to prepare the environment in the Contributing Guidelines. I think conda and pip have both Pros and Cons. For that reason, it will be good that contributor can choose which to use depend on the material.

For example,

  • Level1 (required): prepare the set up instruction by conda or pip.
    • option1: Prepare the environment.yml and describe how to use it in the notebook
    • option2: Execute pip install inside the notebook and mention about how to reset (recover) the environment.
  • Lavel2 (optional): mention about both way (option1 & option2)

If you have some opinions about it, please comment on this issue!

icoxfog417 avatar Dec 06 '22 02:12 icoxfog417