Skip to content

More README tweaks #184

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

Merged
merged 1 commit into from
Oct 29, 2022
Merged

More README tweaks #184

merged 1 commit into from
Oct 29, 2022

Conversation

bmish
Copy link
Owner

@bmish bmish commented Oct 28, 2022

No description provided.

Add scripts to `package.json`:

- Both a lint script to ensure everything is up-to-date in CI and an update script for contributors to run locally
- Add any [config options](#configuration-options) in the `update:eslint-docs` script only
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Add any [config options](#configuration-options) in the `update:eslint-docs` script only
- Add any [configuration options](#configuration-options) in the `update:eslint-docs` script only

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're a bit inconsistent about this wording, but in most of this readme, we've been using "config", so I think I'll leave as is for now.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@bmish bmish merged commit 023e823 into main Oct 29, 2022
@bmish bmish deleted the readme-tweaks-2 branch October 29, 2022 14:59
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.

None yet

2 participants