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

Add README template pathname #24

Closed
wants to merge 1 commit into from

Conversation

ashleywillard
Copy link

@ashleywillard ashleywillard commented Dec 12, 2024

We want to allow users to specify a README template other than the default template currently defined in packs. The README_TODO file currently contains the following text:

Welcome to `#{pack_name}`!

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 (which lives in `#{pack_name}/#{ParsePackwerk::DEFAULT_PUBLIC_PATH}`)
  - 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 (note: it is recommended to add ownership in `#{pack_name}/package.yml` under the `owner` metadata key)
  - 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 files are under version control and should change as your public API changes.#{' '}

See #{documentation_link} for more info!

Some organizations may want to use their own README template. This issue requested the ability to customize the README but was closed due to inactivity. With this change, users can define their own README template, README_TEMPLATE.md, in the project root or specify an alternative path in packs.yml.

Corresponding packs change: rubyatscale/packs#165

  • TODO: tests
  • Bump version

We want to allow users to specify a README template other than the default template currently defined in `packs`. Users can specify an alternative path to this file in `packs.yml` or define `README_TEMPLATE.md` in the project root.
@ashleywillard
Copy link
Author

Teal and I discussed this change. While this makes it very convenient to get the path for the README template, it's not necessary for the public API that this pack provides. If someone were using packs-specification but not packs, they wouldn't need this functionality. I'll move this code to either parse-packwerk or packs.

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.

1 participant