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

Make README template customizable #17

Merged
merged 4 commits into from
Dec 18, 2024

Conversation

ashleywillard
Copy link
Contributor

Allows users to specify a README template other than the default template currently defined in pks. Also allows users to specify a path to the readme template, or by default the template should be located at README_TEMPLATE.md. The generated README.md file currently contains the following text:

Welcome to `{}`!

If you're the author, please consider replacing this file with a README.md, which may contain:
- What your pack is and does
- How you expect people to use your pack
- Example usage of your pack's public API and where to find it
- Limitations, risks, and important considerations of usage
- How to get in touch with eng and other stakeholders for questions or issues pertaining to this pack
- What SLAs/SLOs (service level agreements/objectives), if any, your package provides
- When in doubt, keep it simple
- Anything else you may want to include!

README.md should change as your public API changes.

See https://github.com/rubyatscale/pks#readme for more info!

Some organizations may want to use their own README template. rubyatscale/packs#154 requested the ability to customize the README in packs, but was closed due to inactivity.

@perryqh
Copy link
Contributor

perryqh commented Dec 17, 2024

Run cargo fmt to pass the CLI/Lints step

@perryqh perryqh force-pushed the aw/make-readme-template-customizable branch from a52c07a to 3aa18b1 Compare December 18, 2024 00:57
@perryqh perryqh merged commit 6161fe5 into main Dec 18, 2024
9 checks passed
@perryqh perryqh deleted the aw/make-readme-template-customizable branch December 18, 2024 18:39
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