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

[Feature] Reorganize the file structure of the repository #2

Open
6 of 8 tasks
samgdotson opened this issue Sep 30, 2024 · 0 comments
Open
6 of 8 tasks

[Feature] Reorganize the file structure of the repository #2

samgdotson opened this issue Sep 30, 2024 · 0 comments
Assignees
Labels
Status:1-New No one has claimed this issue yet. It is in need of solving. Type:Feature New feature or feature request

Comments

@samgdotson
Copy link

samgdotson commented Sep 30, 2024

This issue may be closed when there is a PR that does the following things:

  • Adds a LICENSE file (tells people what they're allowed to do with the repository)
  • Adds a .gitignore file (prevents accidentally tracking "cruft").
  • Adds a environment.yml file (to make the work contained herein reproducible).
  • Adds a new directory called notebooks
  • Moves all .ipynb files to the new directory with the command git mv *.ipynb notebooks (to preserve file history)

To the README.md file:

  • Adds a description of the repository (what work is being done, here?)
  • Correctly spells osier (lowercase)
  • Adds instructions to run the code in the repository (how do I install all the necessary packages?)
@samgdotson samgdotson added Status:1-New No one has claimed this issue yet. It is in need of solving. Type:Feature New feature or feature request labels Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status:1-New No one has claimed this issue yet. It is in need of solving. Type:Feature New feature or feature request
Projects
None yet
Development

No branches or pull requests

2 participants