Clean up the README post-skeletonization #127
Merged
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
Since the `scripts/trustymail` file is now integrated directly into the Python package the installation and usage directions in the README must be updated.
Copy in the current configuration of options from the `trustymail.cli` module.
Make sure all titles are using sentence case as appropriate. Update titles that use acronyms to include the acronym's meaning.
mcdonnnj
added
documentation
jsf9k
approved these changes
Jan 23, 2023
dav3r
reviewed
Jan 23, 2023
Since these are acronyms they should be capitalized. Co-authored-by: dav3r <daver@geekpad.com>
Use consistent spacing and punctuation for all command-line options.
jsf9k
approved these changes
Jan 23, 2023
cisagovbot
pushed a commit
that referenced
this pull request
Apr 26, 2023
…s/setup-go-4 Bump actions/setup-go from 3 to 4
cisagovbot
pushed a commit
that referenced
this pull request
Dec 19, 2023
…nore_directives Add new, disabled dependabot ignore directives
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.
🗣 Description
This pull request fixes some things I missed in #125 as well as some minor cleanup.
💭 Motivation and context
The installation/running directions were not updated appropriately with the changes in #125. Since I already needed to fix that portion of the README I did a quick skim of the rest while I was working on the branch.
🧪 Testing
Automated tests pass. I confirmed the README renders as expected when viewing the branch.
✅ Pre-approval checklist