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

review: adding issue templates #64

Merged
merged 13 commits into from
Dec 19, 2023
Merged

review: adding issue templates #64

merged 13 commits into from
Dec 19, 2023

Conversation

emmambd
Copy link

@emmambd emmambd commented May 17, 2023

This PR adds issue templates for the transit repo. I'd like internal review on the template before I open a PR on the main repo.

scmcca and others added 7 commits February 11, 2022 09:30
commit 2e6887e
Author: scmcca <[email protected]>
Date:   Wed Feb 2 12:42:10 2022 -0500

    [Formatting fix] Add newlines before lists

    Improved syntax for different markdown parsers

commit 0033573
Author: Tristram Gräbener <[email protected]>
Date:   Fri Jan 28 15:54:00 2022 +0100

    Specify that the filename are case sensitive (google#300)

    Closes google#297

commit 23d877e
Author: scott christian mccallum <[email protected]>
Date:   Tue Jan 18 19:09:46 2022 -0500

    "Fields" and "Values" as non-header (google#302)
commit 9d5ebf1
Author: Guillaume Campagna <[email protected]>
Date:   Tue Jul 26 17:09:35 2022 -0400

    Add trip-to-trip transfers with in-seat option (google#303)

    * Add trip-to-trip transfers with in-seat option

    * Fix stop_id are **Conditionally Required** and formatting

    * Add clarification about potential conflict

    * Fix typo

    Co-authored-by: Leonard Ehrenfried <[email protected]>

    Co-authored-by: Nicholas Paun <[email protected]>
    Co-authored-by: Leonard Ehrenfried <[email protected]>

commit a132709
Author: McKenzie Maidl <[email protected]>
Date:   Tue Jul 26 13:58:04 2022 -0700

    addition of cause_detail and effect_detail to the spec (google#332)

commit 8993a24
Author: Zsombor Welker <[email protected]>
Date:   Mon Jul 25 14:49:40 2022 +0200

    Add WheelchairAccessible documentation (google#340)
@CLAassistant
Copy link

CLAassistant commented May 17, 2023

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 3 committers have signed the CLA.

✅ emmambd
❌ scmcca
❌ omar-kabbani


scmcca seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@emmambd emmambd requested a review from isabelle-dr May 17, 2023 16:58
@emmambd
Copy link
Author

emmambd commented May 17, 2023

@isabelle-dr If it looks right, I'll merge it into our fork to see how it displays visually before pushing to google/transit.

@emmambd emmambd requested a review from eliasmbd May 17, 2023 17:06
Copy link

@eliasmbd eliasmbd left a comment

Choose a reason for hiding this comment

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

I think this actually works out. I am not too sure if this is what you meant by review. But all the questions seem okay :)

@emmambd
Copy link
Author

emmambd commented Jun 5, 2023

@eliasmbd Yes, I wanted a review of the questions and template types so that's perfect! I'll leave it to Isabelle to let me know if there are any issues with the configuration.

Choose a reason for hiding this comment

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

I think we could potentially add an "alternatives considered" section.

Copy link

@isabelle-dr isabelle-dr left a comment

Choose a reason for hiding this comment

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

I left minor comments, this looks great!
I have recently learned that someone wasn't seeing the "blank issue template" on the schedule validator, and it's true it's not very visible.
I see this as a risk that some people will want to open an issue and abandon it because there is no template that really works for them, or they are too exhaustive. A potential solution could be to have a template that is called "blank issue template".

.github/ISSUE_TEMPLATE/spec_improvement.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/spec_improvement.yml Outdated Show resolved Hide resolved
Copy link

@eliasmbd eliasmbd left a comment

Choose a reason for hiding this comment

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

checked it over, and submitted my comments. This looks really good. Let me know when you want to push, i'd like to help you communicate this PR.

.github/ISSUE_TEMPLATE/extension_proposal.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/spec_improvement.yml Outdated Show resolved Hide resolved
@eliasmbd
Copy link

eliasmbd commented Nov 22, 2023

Would there be a case to add gtfs.org link to the reference pages or to home page to allow for better relay to most commonly referenced pages?

@isabelle-dr
Copy link

Would there be a case to add gtfs.org link to the reference pages or to home page to allow for better relay to most commonly referenced pages?

Is this related to the issue templates?

@eliasmbd
Copy link

Would there be a case to add gtfs.org link to the reference pages or to home page to allow for better relay to most commonly referenced pages?

Is this related to the issue templates?

I see it as an addition to the slack link already in the proposal. Just wondering if it is worth adding that link at the end of the template list, an added resource.

@isabelle-dr isabelle-dr merged commit 65ffbb0 into master Dec 19, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants