📚 Add definition-of-done checklist for connectors into PR template #3864
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
sherifnada changed the title 
tuliren approved these changes Jun 3, 2021
.github/pull_request_template.md Outdated
| - [ ] README | ||
| - [ ] CHANGELOG.md | ||
| - [ ] Reference docs in the `docs/integrations/` directory. | ||
| - [ ] If adding a new connector, update the `docs/SUMMARY.md` to point to the new docs in `docs/integrations/` |
Contributor
There was a problem hiding this comment.
I am working on #3867 on the side, which automatically takes care of the above two entries.
Contributor Author
There was a problem hiding this comment.
wonderful. I'll remove this point then.
| - [ ] Issue acceptance criteria met | ||
| - [ ] Unit & integration tests added as appropriate (and are passing) | ||
| * Community members: please provide proof of this succeeding locally e.g: screenshot or copy-paste acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run `./gradlew :airbyte-integrations:connectors:<name>:integrationTest`. | ||
| - [ ] `/test` command documented [here]() is passing. |
Contributor
There was a problem hiding this comment.
Why don't we write the whole command in the checklist (with the long form so it is compatible with publish)?
/test connector=connectors/<name>
So we can just copy/paste/replace the name and not remember the correct syntax
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
What
Github doesn't support multiple PR templates. But we really need the ability to have different checklists which support different workflows.
How
The solution here is to put all checklists in the single PR template into collapsible sections. The expected flow is to expand the relevant checklist and use that one.