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: document ERROR notices #902

Merged
merged 10 commits into from
May 17, 2021

Conversation

lionel-nj
Copy link
Contributor

@lionel-nj lionel-nj commented May 13, 2021

closes #849

Summary:

This PR provides additional documentation for notices.

TODOs

  • document ERROR notices
  • document WARNING notices
  • document INFO notices
  • document system errors
  • add reference to NOTICES.md in RULES.md and NEW_RULES.md

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)

@lionel-nj lionel-nj self-assigned this May 13, 2021
@lionel-nj lionel-nj added the documentation Anything related to our documentation label May 14, 2021
@lionel-nj lionel-nj marked this pull request as ready for review May 14, 2021 16:49
Copy link
Contributor

@maximearmstrong maximearmstrong left a comment

Choose a reason for hiding this comment

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

Great job! I think only one thing is missing: the notice code for each notices. In the reports, the only way to find a notice is by its code, so I think we should add it here.

Copy link
Contributor

@maximearmstrong maximearmstrong left a comment

Choose a reason for hiding this comment

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

LGTM :)

@maximearmstrong maximearmstrong merged commit c0450c3 into master May 17, 2021
@maximearmstrong maximearmstrong deleted the docs/notices-additional-documentation branch May 17, 2021 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to our documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a NOTICES.md file to complement RULES.md
2 participants