Skip to content

Conversation

@NicolasMassart
Copy link
Contributor

@NicolasMassart NicolasMassart commented Dec 11, 2020

Before pushing any commit in your pull request, make sure that:

Describe the change

  • Update Vale to latest version https://github.com/errata-ai/vale/releases/tag/v2.6.6 (required to add all styles in the project as they are not included in Vale natively anymore)
  • fixes the issues checked by styles
  • add words in accepted list
  • exclude Vale styles from markdown linting (not our docs)

Issue fixed

fixes #560

Impacted parts

For content changes

  • Doc content
  • Doc pages organisation

For tools changes

  • CircleCI workflow
  • Build and QA tools (lint, vale,…)
  • MkDocs templates
  • MkDocs configuration
  • Python dependencies
  • Node dependencies and JavaScript
  • ReadTheDocs configuration
  • Github integration

Review process

You can probably skip looking at the changes in CI/vale/vale_styles/Microsoft, CI/vale/vale_styles/proselint and CI/vale/vale_styles/write-good as they are imported styles I did not change them only moved them or added some.
Only the CI/vale/vale_styles/Besu and CI/vale/vale_styles/Vocab/Besu/accept.txt have changes that you should check.

Testing

Run CI/scripts/test_all.sh

Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
exclude vale style dirs from lint checks

Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
@NicolasMassart NicolasMassart requested a review from a team as a code owner December 11, 2020 13:27
@NicolasMassart NicolasMassart added the DocOps Related to documentation system, tools and CI label Dec 11, 2020
@NicolasMassart NicolasMassart self-assigned this Dec 11, 2020
Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
Copy link
Contributor

@bgravenorst bgravenorst left a comment

Choose a reason for hiding this comment

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

Minor suggestion.

Copy link
Contributor

@MadelineMurray MadelineMurray left a comment

Choose a reason for hiding this comment

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

Couple of minor comments. Nice to see all those spelling errors fixed :-)

Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
@NicolasMassart NicolasMassart merged commit d2383df into hyperledger:master Dec 14, 2020
@NicolasMassart NicolasMassart deleted the 560-update-vale branch December 14, 2020 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

DocOps Related to documentation system, tools and CI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update Vale

3 participants