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: [Documentation changes in RULES.md and NOTICES.md] #940

Merged
merged 11 commits into from
Aug 4, 2021

Conversation

isabelle-dr
Copy link
Contributor

@isabelle-dr isabelle-dr commented Jul 27, 2021

Summary:

This PR includes minor documentation changes in RULES.md and NOTICES.md that were noticed while analysing the current rules present on the validator.
This also closes:

Expected behaviour:
Clearer documentation

Please make sure these boxes are checked before submitting your pull request - thanks!

  • [ ] Run the unit tests with gradle test to make sure you didn't break anything
  • Format the title like "feat: [new feature short description]". Title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
  • Linked all relevant issues
  • [ ] Include screenshot(s) showing how this pull request works and fixes the issue(s)

@CLAassistant
Copy link

CLAassistant commented Jul 27, 2021

CLA assistant check
All committers have signed the CLA.

@isabelle-dr isabelle-dr changed the title Isabelle dr docs change Documentation changes in RULES.md and NOTICES.md Jul 27, 2021
@isabelle-dr isabelle-dr changed the title Documentation changes in RULES.md and NOTICES.md feat: [Documentation changes in RULES.md and NOTICES.md] Jul 27, 2021
RULES.md Show resolved Hide resolved
@isabelle-dr isabelle-dr marked this pull request as draft July 27, 2021 19:26
@isabelle-dr isabelle-dr changed the title feat: [Documentation changes in RULES.md and NOTICES.md] docs: [Documentation changes in RULES.md and NOTICES.md] Jul 27, 2021
@isabelle-dr isabelle-dr marked this pull request as ready for review July 27, 2021 19:35
Copy link
Contributor

@lionel-nj lionel-nj left a comment

Choose a reason for hiding this comment

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

Thanks for working on that @isabelle-dr! One small change: could you reformat the tables with the following tool please? https://www.tablesgenerator.com/markdown_tables

RULES.md Outdated Show resolved Hide resolved
@isabelle-dr
Copy link
Contributor Author

The conflicts are resolved! 🙌
I also moved the SameNameAndDescriptionForRoute from ERROR to WARNING in the section below the tables in RULES.md.

Copy link
Contributor

@lionel-nj lionel-nj left a comment

Choose a reason for hiding this comment

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

Thanks @isabelle-dr

@lionel-nj lionel-nj merged commit c342c96 into master Aug 4, 2021
@lionel-nj lionel-nj deleted the isabelle-dr-docs-change branch August 4, 2021 17:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants