docs: add explicit PLACEHOLDER and TODO markers in the readme #244
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nedbat
force-pushed
the
nedbat/readme-placeholders
branch
from
74a4be5 to
93729bd
Compare
This was referenced Aug 12, 2022
timmc-edx
reviewed
Aug 15, 2022
Comment on lines
+11
to
+13
| .. I wish we used a tool to manage changelogs so that I didn't have to choose | ||
| a date when I made a commit, since I don't know what date the change will | ||
| be merged... |
There was a problem hiding this comment.
And we don't even "release" cookiecutters. I have a canned rant about how we manage versioning in changelogs for repos where we do cut releases...
timmc-edx
reviewed
Aug 15, 2022
timmc-edx
approved these changes
Aug 15, 2022
This will serve as clear indicators: - Readers will know the content is auto-generated - Maintainers will know the content needs to be updated - Maintainers will know where edits are needed - Linters can find these markers to alert people that work is needed.
nedbat
force-pushed
the
nedbat/readme-placeholders
branch
from
93729bd to
232d980
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This will serve as clear indicators: