Skip to content

Conversation

@NicolasMassart
Copy link
Contributor

@NicolasMassart NicolasMassart commented Dec 14, 2020

Pull request checklist

Use the following list to make sure your PR fits the Besu doc quality standard.

Before creating the pull request

Make sure that:

After creating your pull request and tests finished

Make sure that:

  • you fixed all the issues raised by the tests, if any.
  • you verified the rendering of your changes on ReadTheDocs.org PR preview
    and updated the testing link (see Testing).

Describe the change

Update the PR template to make the checklist more explicit and split the list into before PR and after PR creation.

Issue fixed

No issue created just for this, only some discussion.

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

Testing

this PR description uses the modified template

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

- [ ] you fixed all the issues raised by the tests, if any.
- [ ] you verified the rendering of your changes on [ReadTheDocs.org PR preview](https://wiki.hyperledger.org/display/BESU/MkDocs+And+Markdown+Guide#MkDocsAndMarkdownGuide-PreviewwithReadTheDocs)
and updated the testing link (see [Testing](#testing)).
Copy link
Contributor

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@macfarla macfarla left a comment

Choose a reason for hiding this comment

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

LGTM

@NicolasMassart NicolasMassart deleted the update-pr-template branch December 14, 2020 11:26
@NicolasMassart NicolasMassart restored the update-pr-template branch December 14, 2020 11:27
@NicolasMassart NicolasMassart merged commit c05ea3b into hyperledger:master Dec 14, 2020
@NicolasMassart NicolasMassart deleted the update-pr-template branch December 14, 2020 11:30
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.

3 participants