Skip to content

Conversation

@sjvrijn
Copy link
Contributor

@sjvrijn sjvrijn commented Aug 19, 2024

Summary

Fixes #404, fixes #416

  • Removes separate ADD_TO_EXISTING_PACKAGE.md file
  • Updates README.md usage section with copier instructions for creating a new project, applying the template to existing code, and updating using the template.

Checklist:

@sjvrijn sjvrijn requested review from fdiblen and lyashevska August 19, 2024 15:34
@sjvrijn sjvrijn changed the title fix typo README: Update usage instructions Aug 19, 2024
README.md Outdated
| code_of_conduct_email | yourname@esciencecenter.nl | Email address of the person who should be contacted in case of violations of the Code of Conduct. |

Once the project files have been generated, follow the steps outlined in
[template/next_steps.md](template/next_steps.md).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[template/next_steps.md](template/next_steps.md).
[next_steps.md](next_steps.md).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While the file will just be next_steps.md, if we functionally link to it, we have to link to template/next_steps.md.

I'll change just the text part, but leave the link intact.

Copy link
Member

@fdiblen fdiblen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job @sjvrijn! I made a few suggestions.

Copy link
Collaborator

@lyashevska lyashevska left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @sjvrijn Looks great, I have left a few suggestions.

sjvrijn and others added 7 commits August 20, 2024 11:16
Co-authored-by: fdiblen <144492+fdiblen@users.noreply.github.com>
Co-authored-by: Olga Lyashevska <olga.lyashevska@gmail.com>
Co-authored-by: Olga Lyashevska <olga.lyashevska@gmail.com>
Co-authored-by: Olga Lyashevska <olga.lyashevska@gmail.com>
@sjvrijn sjvrijn merged commit 7548239 into dev Aug 20, 2024
@sjvrijn sjvrijn deleted the 416-instructions-update-existing branch August 20, 2024 10:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants