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: Update new rules documentation #837

Merged
merged 4 commits into from
Mar 26, 2021
Merged

Conversation

barbeau
Copy link
Member

@barbeau barbeau commented Mar 25, 2021

Summary:

This PR attempts to simply the new rules documentation by taking the approach of providing an example, and then walking through sections of the example for both FileValidators and SingleEntityValidators, but always presenting FileValidators file to follow the initially introduced example of the TripUsabilityValidator. It also attempts to shorten text when possible and provide some additional context when needed.

It also fixes references to the SingleEntityValidator sections, some of which mixed references to FeedExpirationDateValidator and FeedServiceDateValidator.

Expected behavior:

New rules documentation should present an example and then walk the reader through it, providing only the basic information needed to understand the example.

A lot of text in-line was changed with existing text moved around, so it will probably be easier to view this change in it's entirely by clicking on the 3 dots in the "Files changed" tab and doing "View file".

  • 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)

This PR attempts to simply the new rules documentation by taking the approach of providing an example, and then walking through sections of the example for both FileValidators and SingleEntityValidators, but always presenting FileValidators file to follow the initially introduced example of the TripUsabilityValidator. It also attempts to shorten text when possible and provide some additional context when needed.

It also fixes references to the SingleEntityValidator sections, some of which mixed references to FeedExpirationDateValidator and FeedServiceDateValidator.
@barbeau barbeau added the documentation Anything related to our documentation label Mar 25, 2021
@barbeau barbeau requested a review from lionel-nj March 25, 2021 17:00
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 @barbeau for this more narrative version! Just a few minor changes in line.

docs/NEW_RULES.md Outdated Show resolved Hide resolved
docs/NEW_RULES.md Outdated Show resolved Hide resolved
barbeau and others added 3 commits March 26, 2021 11:27
Co-authored-by: Lionel Nébot Janvier <35747326+lionel-nj@users.noreply.github.com>
Co-authored-by: Lionel Nébot Janvier <35747326+lionel-nj@users.noreply.github.com>
@barbeau
Copy link
Member Author

barbeau commented Mar 26, 2021

Thanks @lionel-nj! I committed your suggestions, and fixed another typo I found.

@barbeau barbeau requested a review from lionel-nj March 26, 2021 15:29
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.

👍🏾 lgtm!

@lionel-nj lionel-nj merged commit 54572ae into master Mar 26, 2021
@lionel-nj lionel-nj deleted the sean/docs-new-rules-update branch March 26, 2021 16:09
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.

None yet

2 participants