New features #14
Open
New features #14
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jvanderleeuw
requested review from
julianpistorius,
Chris-Schnaufer and
dlebauer
Chris-Schnaufer
requested changes
Oct 6, 2020
|
Can there be a GitHub action that checks the cookiecutter stuff? |
|
Much more information on how to use the cookie cutter approach is needed in the README. I would have no idea as to what should be done if I didn't know about cookie cutter. Also add information on what can be done if someone is not using cookie cutter. Finally, the Jupyter Notebook should be removed from here (see draft PR #13) |
Chris-Schnaufer
requested changes
Nov 12, 2020
3 tasks
Chris-Schnaufer
approved these changes
Mar 15, 2021
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The changes made included adding README.md generation and Cookiecutter capabilities, and a jupyter notebook.
README generation takes place through https://github.com/andreasbm/readme . The process is that there is an original README.md that the user receives when they clone/download the repo for template-rgb-plot in general. After the user edits the cookiecutter.json file, they can generate a new README.md in a project folder that will ultimately stand on its own once the user creates their own project. This one will be personalized based on the metadata included in the Cookiecutter.json file.
After the user is finished creating their project, they can use Cookiecutter in order to make the folder originally titled {{ Cookiecutter._project_name }} a repository of its own
A jupyter notebook was also added and is accessible through this link. It may not be completely up to date yet but should be soon.