FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

467-Add dev doc question by lyashevska · Pull Request #541 · NLeSC/python-template · GitHub

467-Add dev doc question - #541

Merged
lyashevska merged 4 commits into
mainfrom
467-devdoc
Aug 23, 2024
Merged

467-Add dev doc question#541
lyashevska merged 4 commits into
mainfrom
467-devdoc

Conversation

lyashevska commented Aug 23, 2024
edited
Loading

Copy link
Copy Markdown
Collaborator

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

fdiblen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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.

Copy link
Copy Markdown
Collaborator Author

Good catch. Will fix it now.

lyashevska requested a review from fdiblen August 23, 2024 17:14

fdiblen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

looks good! Reasy to be merged.

lyashevska merged commit e8527f8 into main Aug 23, 2024
lyashevska deleted the 467-devdoc branch August 23, 2024 17:19
This file contains hidden or 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
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


Back | FazBrowse Home | New Git URL