Skip to content

Conversation

lucacome
Copy link
Contributor

Proposed changes

The README is very long and it's hard to find things without a TOC.
The Contributing Guidelines had new sections that were never added to the TOC.

With doctoc we can keep the TOCs up to date automatically.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING guide
  • I have proven my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have ensured the README is up to date
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch on my own fork

@lucacome lucacome requested a review from a team as a code owner July 17, 2024 00:35
@github-actions github-actions bot added documentation Pull requests/issues for documentation chore Pull requests for routine tasks labels Jul 17, 2024
@lucacome lucacome added this to the v1.3.0 milestone Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Pull requests for routine tasks documentation Pull requests/issues for documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants