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

467-Add dev doc question #541

Merged
merged 4 commits into from
Aug 23, 2024
Merged

467-Add dev doc question #541

merged 4 commits into from
Aug 23, 2024

Conversation

lyashevska
Copy link
Member

@lyashevska lyashevska commented Aug 23, 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 developer documentation questions.

copier copy --vcs-ref 467-devdoc https://github.com/nlesc/python-template test_yes

Step-2:
Run the command below and say 'no' to developer documentation question

copier copy --vcs-ref 467-devdoc https://github.com/nlesc/python-template test_no

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

README.dev.md
CONTRIBUTING.md should contain a reference to README.dev.md

@lyashevska lyashevska marked this pull request as ready for review August 23, 2024 12:25
@lyashevska lyashevska requested a review from fdiblen August 23, 2024 12:25
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 for the contribution, @lyashevska.

When I say no to developer documentation, next_steps.md stills has a reference to README.dev.md. Can you please also fix this?

next_steps.md:43:The [README.dev.md](README.dev.md) contains developer documentation.

@lyashevska
Copy link
Member Author

Good catch. Will fix it now.

@lyashevska lyashevska requested a review from fdiblen August 23, 2024 17:14
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.

looks good! Reasy to be merged.

@lyashevska lyashevska merged commit e8527f8 into main Aug 23, 2024
15 checks passed
@lyashevska lyashevska deleted the 467-devdoc branch August 23, 2024 17:19
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.

2 participants