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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: RULES.md update #1307

Merged
merged 22 commits into from
Jan 31, 2023
Merged

Doc: RULES.md update #1307

merged 22 commits into from
Jan 31, 2023

Conversation

isabelle-dr
Copy link
Contributor

@isabelle-dr isabelle-dr commented Dec 17, 2022

Summary:

Another documentation update! 馃檭
Included in this PR:

  • more clear mention that "GTFS Best Practices" are the combination of: the GTFS Best Practices document + all the SHOULD statement in the spec, translated in a validation WARNING. This came from a discussion with Cal-ITP around the need to have a clear way to measure GTFS Best Practice compliance, and the confusion around if the spec "should" statements were part of it, or if we needed two GTFS Best Practices.
  • broken link fixed in a stale PR (docs: Fix broken links in RULES.md聽#1295 )
  • links that were referencing to GitHub instead of gtfs.org

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)

@isabelle-dr isabelle-dr marked this pull request as draft January 16, 2023 21:26
@isabelle-dr isabelle-dr marked this pull request as ready for review January 30, 2023 18:21
Copy link
Contributor

@emmambd emmambd left a 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

@isabelle-dr isabelle-dr changed the title Doc: add provenance of notices (& some tidying up) Doc: RULES.md update Jan 30, 2023
@isabelle-dr
Copy link
Contributor Author

@fredericsimard ready to merge :)

@fredericsimard fredericsimard merged commit 0f53a51 into master Jan 31, 2023
@fredericsimard fredericsimard deleted the update-rules.md branch January 31, 2023 14:55
KClough pushed a commit to JarvusInnovations/gtfs-validator that referenced this pull request Feb 24, 2023
* update descriptions & add source column

* attempt to format table

* other attempt

* test

* test to format column width

* Update RULES.md

* Update RULES.md

* revert

* Revert "test"

This reverts commit 89ce7d9.

* Revert "other attempt"

This reverts commit 7e23704.

* Revert "attempt to format table"

This reverts commit 0d9bbc0.

* formatting issues

* modify how to represent source

* Fix headers, re-write descriptions

* small change

* replace provenance by source

* Update RULES.md

* fix broken links

* fix links

* update description of missing required file
KClough pushed a commit to JarvusInnovations/gtfs-validator that referenced this pull request Mar 1, 2023
* update descriptions & add source column

* attempt to format table

* other attempt

* test

* test to format column width

* Update RULES.md

* Update RULES.md

* revert

* Revert "test"

This reverts commit 89ce7d9.

* Revert "other attempt"

This reverts commit 7e23704.

* Revert "attempt to format table"

This reverts commit 0d9bbc0.

* formatting issues

* modify how to represent source

* Fix headers, re-write descriptions

* small change

* replace provenance by source

* Update RULES.md

* fix broken links

* fix links

* update description of missing required file
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants