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

docs: regenerate README.md #470

Merged
merged 1 commit into from
Mar 17, 2021
Merged

docs: regenerate README.md #470

merged 1 commit into from
Mar 17, 2021

Conversation

mrtnzlml
Copy link
Contributor

Followup after fd838c3

I didn't generate the docs because I misunderstood the contribution guide. This commit fixes it and updates the contribution guide a little bit.

Followup after fd838c3

I didn't generate the docs because I misunderstood the contribution guide. This commit fixes it and updates the contribution guide a little bit.
@@ -51,7 +47,6 @@ Just before submitting a PR, run `npm run create-readme` to generate the new REA
* Use [./.README/rules/require-valid-file-annotation.md](./.README/rules/require-valid-file-annotation.md) as a template.
* Ensure that rule documentation document includes `<!-- assertions spaceAfterTypeColon -->` declaration.
1. Update [./.README/README.md](/.README/README.md) to include the new rule.

A CI service will build and publish the new documentation.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am not sure about this change, however, there doesn't seem to be this kind of automation. 🤔

@Brianzchen
Copy link
Contributor

@gajus

@gajus gajus merged commit 8fd60d6 into gajus:master Mar 17, 2021
@mrtnzlml mrtnzlml deleted the docs_regenerate_readme branch March 17, 2021 13:38
@gajus
Copy link
Owner

gajus commented Apr 5, 2021

🎉 This PR is included in version 5.5.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@gajus gajus added the released label Apr 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants