-
Notifications
You must be signed in to change notification settings - Fork 100
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 RULES.md to include NOTICES.md information & delete NOTICES.md #1132
Conversation
NEW_RULES.md is used if someone wants to contribute to a new rule, and RULES.md is used to interpret the validation report
+ a lot of cleanup
@maximearmstrong this is ready for review! :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some suggestions for changes in-line before approval. Thank you for this @isabelle-dr!
Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>
Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>
…a/gtfs-validator into documentation-update
Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>
Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>
Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>
I have applied the changes:
@barbeau PTAL, the work is done on my end :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for all this work @isabelle-dr! I think it looks much better than before - much easier to read IMHO.
I found a few small typos in the below comments/suggestions.
Co-authored-by: Sean Barbeau <sjbarbeau@gmail.com>
Co-authored-by: Sean Barbeau <sjbarbeau@gmail.com>
Co-authored-by: Sean Barbeau <sjbarbeau@gmail.com>
Co-authored-by: Sean Barbeau <sjbarbeau@gmail.com>
Co-authored-by: Sean Barbeau <sjbarbeau@gmail.com>
Co-authored-by: Sean Barbeau <sjbarbeau@gmail.com>
What an eye @barbeau! 🧐 Thank you @maximearmstrong, could you have a last look & approve this PR if it all looks good? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks @isabelle-dr!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2 small things aside, LGTM! Thank you @isabelle-dr :)
Also, we had to reconfigure the CLA assistant last week and I think we will need your signature in order to merge.
Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>
Co-authored-by: Maxime Armstrong <46797220+maximearmstrong@users.noreply.github.com>
Thank you @isabelle-dr ! The other checks won't be performed because this PR only changes the |
Closes #1006
Closes #1154
Summary:
Following the discussions in PR #1127 (comment), the objective of this PR is to provide a better user experience when reading the validation report. This is part of the effort of the 3.1.0 release.
The HTML report in #1127 will link to the corresponding piece of documentation using the anchor links, in order to ease the process of (1) understanding what the issue is, and (2) fixing the dataset.
This PR contains the following changes:
Expected outcomes:
Please make sure these boxes are checked before submitting your pull request - thanks!
Run the unit tests withgradle test
to make sure you didn't break anything