Update issue templates #133
Conversation
|
|
@varundhall this is updating the templates for issues (which we are opening) |
There was a problem hiding this comment.
@fivetran-elijahdavis these changes don't follow the standard GitHub YAML structure. Please refer https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository
-@varundhall Updated and new format attached |
|
@alsnkline @fivetran-sadiemartin - Should we add something about Save Me Time? "Need help getting your first connection up and running quickly? Our team of Professional Services experts is available to provide free advisory services to help you build your first Connector SDK connection. This includes guidance on setup, troubleshooting, and best practices. To get started, simply file a support ticket." |
| attributes: | ||
| label: Contact Details | ||
| description: How can we get in touch with you if we need more info? | ||
| placeholder: ex. email@example.com |
There was a problem hiding this comment.
This is a sensitive detail; people don't feel comfortable sharing the emails publicly.
There was a problem hiding this comment.
This will be removed
| id: version | ||
| attributes: | ||
| label: Connector SDK version | ||
| description: What version of Connector SDK are you using? You can check the version with 'pip show fivetran-connector-sdk' or install the latest version with 'pip install --upgrade fivetran-connector-sdk.' |
There was a problem hiding this comment.
while asking for version we are also telling to upgrade to the latest, which can provide incorrect response. Let's just stick to pip show
There was a problem hiding this comment.
Sounds good
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com). |
There was a problem hiding this comment.
example.com? Please update or review the AI generated stuff 😄
There was a problem hiding this comment.
It's an example to start the dialogue with product. So...do we want a code of conduct or not?
@fivetran-sadiemartin / @alsnkline - do we want to include a code of conduct or no?
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com). | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct |
There was a problem hiding this comment.
Do we even have such code of conduct?
There was a problem hiding this comment.
It's an example to start the dialogue with product. So...do we want a code of conduct or not?
@fivetran-sadiemartin / @alsnkline - do we want to include a code of conduct or no?
There was a problem hiding this comment.
There was a problem hiding this comment.
Looks easy to add one based on https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
.github/ISSUE_TEMPLATE/request.yml
Outdated
| name: Request | ||
| description: Suggest an idea for a Connector SDK project. | ||
| title: "[Request]: " | ||
| labels: ["Project", "New Feature"] |
There was a problem hiding this comment.
We should check with Product, which labels they want and how
There was a problem hiding this comment.
@fivetran-sadiemartin / @alsnkline - what labels would you like shown in the forms?
There was a problem hiding this comment.
didn't we discuss this in our meeting?
how about:
"bug"
"enhancement"
"documentation"
"question"
"duplicate". "invalid", "wontfix"
ChatGPT had a bunch of other suggestions that we likely don't need at first.
.github/ISSUE_TEMPLATE/request.yml
Outdated
| attributes: | ||
| label: Contact Details | ||
| description: How can we get in touch with you if we need more info? | ||
| placeholder: ex. email@example.com |
.github/ISSUE_TEMPLATE/request.yml
Outdated
| id: version | ||
| attributes: | ||
| label: Connector SDK version | ||
| description: What version of Connector SDK are you using? You can check the version with 'pip show fivetran-connector-sdk' or install the latest version with 'pip install --upgrade fivetran-connector-sdk.' |
.github/ISSUE_TEMPLATE/request.yml
Outdated
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com). | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| required: true |
|
Re save me time here We currently point back to the docs in a section about support - and have a purple call out at the top of that page. I think that's good enough. |
add code of conduct link
add code of conduct link
|
@varundhall / @alsnkline - all changes have been added to the templates. The last item is what contact information we put in the code of conduct. Do we use one from CSG or mine?
|
|
I'll ask amanda about using developers. |
|
I checked with Amanda she suggested using sdk@fivetran.com which she monitors and is currently only used for new partners submitting requests to the Partner SDK program. I think that's a perfect address to use for this. |
add contact info for enforcement
No description provided.