pcdshub / pcdshub/cookiecutter-pcds-python
Consider adding version number header to vendored source files
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
Specifically, modulename.version (version.py:
https://github.com/pcdshub/cookiecutter-pcds-python/blob/8fa0cd7fc9ec3ffcd23c8ea8bea5b9d72f980a7a/%7B%7B%20cookiecutter.folder_name%20%7D%7D/%7B%7B%20cookiecutter.import_name%20%7D%7D/version.py#L1)
It would be good to know if we have the latest in each of our repositories without diffing code.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the generated template file at {{ cookiecutter.folder_name }}/{{ cookiecutter.import_name }}/version.py, linked in the issue, and inspect how vendored source files are produced. Determine the version-header format and where it should be added; done means generated files identify their source version without requiring a code diff.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100