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

feat: Added workflow for better Recognize/Credit Contributors #1602

Open
wants to merge 23 commits into
base: master
Choose a base branch
from

Conversation

qcdyx
Copy link
Contributor

@qcdyx qcdyx commented Nov 17, 2023

Summary:

added a github action that writes developer contribution to credits.md
(I opt to include developer contributions in the credits.md file upon the creation of a pull request. This decision is made because certain pull requests may not be merged, yet the contributors are actively contributing to the gtfs-validator with the aim of better acknowledging their efforts.)

Expected behavior:

Testing tips:

  1. create a PR
  2. You will see a Update credits checks running automatically in your PR
  3. If succeed, the Githut Action will write your contribution summary and push the changes in your branch.
Screenshot 2023-11-22 at 10 33 10 AM

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)

Copy link
Contributor

✅ Rule acceptance tests passed.
New Errors: 0 out of 1477 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1477 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1477 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1477 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1477 sources (~0 %) are corrupted.
Commit: 9f08596
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

Copy link
Contributor

✅ Rule acceptance tests passed.
New Errors: 0 out of 1477 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1477 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1477 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1477 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1477 sources (~0 %) are corrupted.
Commit: adc2675
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ qcdyx
❌ actions-user
You have signed the CLA already but the status is still pending? Let us recheck it.

1 similar comment
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ qcdyx
❌ actions-user
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Contributor

✅ Rule acceptance tests passed.
New Errors: 0 out of 1477 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1477 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1477 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1477 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1477 sources (~0 %) are corrupted.
Commit: d2d8c49
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

@qcdyx qcdyx changed the title feat: Sidecar jlu feat: Recognize/Credit Contributors Nov 20, 2023
@qcdyx qcdyx changed the title feat: Recognize/Credit Contributors feat: Added workflow for better Recognize/Credit Contributors Nov 20, 2023
@qcdyx qcdyx marked this pull request as draft November 20, 2023 17:18
Copy link
Contributor

✅ Rule acceptance tests passed.
New Errors: 0 out of 1477 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1477 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1477 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1477 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1477 sources (~0 %) are corrupted.
Commit: 97ca8e9
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

@qcdyx qcdyx marked this pull request as ready for review November 20, 2023 20:01
Copy link
Contributor

✅ Rule acceptance tests passed.
New Errors: 0 out of 1477 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1477 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1477 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1477 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1477 sources (~0 %) are corrupted.
Commit: 7ab1196
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

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.

@qcdyx Sorry for the wait on this! Love this idea. A few comments:

  1. It would be great to link to the CREDITS.md in the Contributing section of the README, so anyone looking can go see the list of everyone contributing.
  2. I think the Contributors section of Github has similar logic to your current PR - when a PR is merged, they're added to this graph. https://github.com/MobilityData/gtfs-validator/graphs/contributors. I'd consider modifying the logic of this action so it's providing unique insight:
  • Any time a PR is merged (since that's when it impacts users)
  • Any time an issue is written (this way we can shoutout contributors outside of dev contributors!)

Copy link
Contributor

📝 Acceptance Test Report

📋 Summary

✅ The rule acceptance has passed for commit d6dbf72
Download the full acceptance test report here (report will disappear after 90 days).

📊 Notices Comparison

New Errors (0 out of 1575 datasets, ~0%) ✅

No changes were detected due to the code change.

Dropped Errors (0 out of 1575 datasets, ~0%) ✅

No changes were detected due to the code change.

New Warnings (0 out of 1575 datasets, ~0%) ✅

No changes were detected due to the code change.

Dropped Warnings (0 out of 1575 datasets, ~0%) ✅

No changes were detected due to the code change.

🛡️ Corruption Check

0 out of 1575 sources (~0 %) are corrupted.

⏱️ Performance Assessment

📈 Validation Time

Assess the performance in terms of seconds taken for the validation process.

Time Metric Dataset ID Reference (s) Latest (s) Difference (s)
Average -- 3.98 4.16 ⬆️+0.18
Median -- 1.41 1.51 ⬆️+0.10
Standard Deviation -- 10.81 11.00 ⬆️+0.19
Minimum in References Reports us-california-flex-v2-developer-test-feed-3-gtfs-1819 0.51 0.62 ⬆️+0.11
Maximum in Reference Reports gb-unknown-uk-aggregate-feed-gtfs-2014 290.90 297.49 ⬆️+6.59
Minimum in Latest Reports ph-unknown-hm-transport-inc-and-robinsons-malls-gtfs-1105 0.54 0.56 ⬆️+0.02
Maximum in Latest Reports gb-unknown-uk-aggregate-feed-gtfs-2014 290.90 297.49 ⬆️+6.59

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.

5 participants