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 description about environment to Contributing Guidelines #177

Open
icoxfog417 opened this issue Dec 6, 2022 · 0 comments
Open

Add description about environment to Contributing Guidelines #177

icoxfog417 opened this issue Dec 6, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@icoxfog417
Copy link
Contributor

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 icoxfog417 added the documentation Improvements or additions to documentation label Dec 6, 2022
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