Developer instructions in README → CONTRIBUTING? #466
Labels
documentation
Improvements or additions to documentation
Comments
This was referenced Oct 22, 2024
samcunliffe
added a commit
that referenced
this issue
Nov 4, 2024
I've attempted to simplify the user-facing quick-start instructions. Not a huge fan of enumerated instructions and the optional (but cool) one-liner it doesn't really fit in 1. 2. 3.... Also it's a bit overkill to have a venv/conda environment just for cookiecutter itself. The cookiecutter docs recommend `pipx install`. I claim that we want to encourage `uvx` because it's fast and cool 😎 . I've spent a bit of effort trying to be clear but comments on clarity etc are very welcome. I also moved and merged the dev instructions into CONTRIBUTING so README is _**just**_ user-facing. And CONTRIBUTING is just dev. This addresses - #466 And two comments - #464 (comment) - #419 (comment) --------- Co-authored-by: David Stansby <[email protected]> Co-authored-by: Patrick J. Roddy <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Which Section of the Documentation Needs Improving?
The top-level README contains developer instructions which overlap with the instructions in CONTRIBUTING.md.
What Can be Improved About This Section
We should merge these. Presumably all developer instructions out into CONTRIBUTING, and leave README with just instructions for users, and our avatars.
How to Improve This Section
No response
The text was updated successfully, but these errors were encountered: