Skip to content

Conversation

@lyashevska
Copy link
Collaborator

@lyashevska lyashevska commented Aug 26, 2024

Description

Related issues:

Install the requirements

cd $(mktemp -d --tmpdir py-tmpl-XXXXXX)
pip install pipx
pipx install copier

Test 1:

Step-1:
Run the command below and say 'yes' to contributing guideline question.

copier copy --vcs-ref 493-project-setup https://github.com/nlesc/python-template test_yes

Step-2:
Run the command below and say 'no'.

copier copy --vcs-ref 493-project-setup https://github.com/nlesc/python-template test_no

What to check:
You should see the files below only when you say 'yes':

README.md should contain a reference to project setup instructions.
project_setup.md

@lyashevska lyashevska requested a review from fdiblen August 26, 2024 14:27
@lyashevska lyashevska marked this pull request as ready for review August 26, 2024 14:28
Co-authored-by: fdiblen <144492+fdiblen@users.noreply.github.com>
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.

Thank you @lyashevska. it looks good, please fix the conflicts before merging.

@lyashevska
Copy link
Collaborator Author

We decided to keep project_setup.md for all profiles. we refer to this document in README.md and it will be shipped with the package.

@lyashevska lyashevska closed this Aug 27, 2024
@fdiblen fdiblen deleted the 493-project-setup branch August 27, 2024 12:54
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.

3 participants