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

Replace todo files with README.md #166

Merged
merged 5 commits into from
Jan 3, 2025

Conversation

ashleywillard
Copy link
Contributor

@ashleywillard ashleywillard commented Dec 17, 2024

  • I bumped the gem version (or don't need to) 💎

Current behavior

When creating a new pack with packs, you get README_TODO.md and app/public/TODO.md files by default. In contrast, pks creates only a README.md file.

Desired behavior

packs and pks should create the same README files. This PR updates packs to behave like pks. I chose to change packs because:

  1. The README_TODO.md and app/public/TODO.md files are often not replaced.
  2. Documentation of the public API typically lives in the README.md file, so we don't really need a separate file telling you to add to README.md.

Limitations

Note that this change brings packs more in line with pks, but pks still creates a few more folders that packs does not (e.g. spec).

@ashleywillard ashleywillard force-pushed the aw/replace-todo-files-with-readme branch from 5119168 to 3fb23df Compare December 17, 2024 22:05
@ashleywillard ashleywillard force-pushed the aw/replace-todo-files-with-readme branch from 3fb23df to 3afecf5 Compare January 2, 2025 22:21
ashleywillard and others added 2 commits January 2, 2025 15:59
Co-authored-by: Teal Stannard <[email protected]>

Update spec/packs_spec.rb

Co-authored-by: Teal Stannard <[email protected]>
@ashleywillard ashleywillard force-pushed the aw/replace-todo-files-with-readme branch from a73ea03 to 57fdc04 Compare January 2, 2025 23:59
@ashleywillard ashleywillard merged commit cef0945 into main Jan 3, 2025
6 checks passed
@ashleywillard ashleywillard deleted the aw/replace-todo-files-with-readme branch January 3, 2025 00:26
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