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.

Sign up for GitHub

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

Jump to bottom

Discuss best location for result/output files #55

Open
tobyhodges opened this issue Jul 24, 2020 · 2 comments
Open

Discuss best location for result/output files #55

tobyhodges opened this issue Jul 24, 2020 · 2 comments
Labels
help wanted Looking for Contributors

Comments

@tobyhodges
Copy link
Member

Several CC@Home2020 participants were keen to learn good practice for where to put results/outputs files (inside or outside 'data' folder?), whether to put them under version control, etc.

The material could be improved by adding discussing this somehwere - maybe episode 1, or maybe later in the lesson if more appropriate. This could include mention of using .gitignore to prevent certain intermediate/results files from being included in the repository e.g. if very large.
@brownsarahm brownsarahm added the help wanted Looking for Contributors label Jul 27, 2020
@vinisalazar
Copy link
Contributor

I believe this could be inserted in Episode 02. On the .gitignore section, there is a sentence that explicitly says:

[...] Results should be ignored.

I could push a commit to #75 (or make a separate PR) expanding the .gitignore explanation and adding a mkdir results command in the code block at the start of the lesson.

Best,
Vini

@brownsarahm
Copy link
Collaborator

I agree that's a good place to add this material, but in a separate PR

vinisalazar added a commit to vinisalazar/python-packaging-publishing that referenced this issue May 26, 2021
@vinisalazar
_episodes/02-project-setup.md: Improving challenge.
b840d1b 
  - Related to carpentries-incubator#55.
  - Renames challenge from 'Exercise' to 'Creating project files'.
  - Adds 'mkdir results' command.
  - Improves explanation of .gitignore.
@vinisalazar vinisalazar mentioned this issue May 26, 2021
Open
vinisalazar added a commit to vinisalazar/python-packaging-publishing that referenced this issue May 31, 2021
@vinisalazar
_episodes/02-project-setup.md: Improving .gitignore and results expla…
558386a 
…nation.

  - Related to carpentries-incubator#55.
  - Code review for carpentries-incubator#81.
  - Add callout block for 'Where to store results?'
  - Add section of configuration files and .gitignore.
vinisalazar added a commit to vinisalazar/python-packaging-publishing that referenced this issue May 31, 2021
@vinisalazar
_episodes/02-project-setup.md: Improving challenge.
5c2f861 
  - Related to carpentries-incubator#55.
  - Renames challenge from 'Exercise' to 'Creating project files'.
  - Adds 'mkdir results' command.
  - Improves explanation of .gitignore.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Looking for Contributors
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@tobyhodges @brownsarahm @vinisalazar