maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
kibana/.github/PULL_REQUEST_TEMPLATE.md

19 lines
1.4 KiB
Markdown
Raw Normal View History

[PROPOSAL] Make Kibana's PR template a checklist (#23511) Kibana now uses a checklist for its PR template. The contributing docs were updated with more detail about release process.
2018-09-28 18:36:31 +02:00
## Summary
Summarize your PR. If it involves visual changes include a screenshot or gif.
### Checklist
Improve pull request template proposal (#56756) Looking through Kibana PRs many currently ignore the check boxes or just delete them. The goal here is to make the process easier, delete some unused options and align the checkboxes with what's most useful. We've had some discussions on the Uptime team about ways the PR template could be potentially improved. These changes are based on an extended discussion we had on the topic. We'd love to hear if other teams would be OK with these recommended changes. The changes here are: * Allow authors to just delete unnecessary items rather than strike through. Adding all the `~~` in markdown is painful * Remove the unnecessary checkbox for release notes, the build bot catches this and blocks merges without that being set. * Add a checkbox for testing in various browser sizes / mobile responsive devices * Move IE checkbox to the bottom of the list since it's seldom checked and makes the checklist seem daunting
2020-02-05 05:07:37 +01:00
Delete any items that are not applicable to this PR.
[PROPOSAL] Make Kibana's PR template a checklist (#23511) Kibana now uses a checklist for its PR template. The contributing docs were updated with more detail about release process.
2018-09-28 18:36:31 +02:00
- [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/master/packages/kbn-i18n/README.md)
Update links that pointed to CONTRIBUTING.md (#74757) * Update links that pointed to CONTRIBUTING.md * Update .github/PULL_REQUEST_TEMPLATE.md point to master instead of 7.x
2020-08-11 16:18:12 +02:00
- [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials
- [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios
[PROPOSAL] Make Kibana's PR template a checklist (#23511) Kibana now uses a checklist for its PR template. The contributing docs were updated with more detail about release process.
2018-09-28 18:36:31 +02:00
- [ ] This was checked for [keyboard-only and screenreader accessibility](https://developer.mozilla.org/en-US/docs/Learn/Tools_and_testing/Cross_browser_testing/Accessibility#Accessibility_testing_checklist)
Improve pull request template proposal (#56756) Looking through Kibana PRs many currently ignore the check boxes or just delete them. The goal here is to make the process easier, delete some unused options and align the checkboxes with what's most useful. We've had some discussions on the Uptime team about ways the PR template could be potentially improved. These changes are based on an extended discussion we had on the topic. We'd love to hear if other teams would be OK with these recommended changes. The changes here are: * Allow authors to just delete unnecessary items rather than strike through. Adding all the `~~` in markdown is painful * Remove the unnecessary checkbox for release notes, the build bot catches this and blocks merges without that being set. * Add a checkbox for testing in various browser sizes / mobile responsive devices * Move IE checkbox to the bottom of the list since it's seldom checked and makes the checklist seem daunting
2020-02-05 05:07:37 +01:00
- [ ] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)
Remove IE11 mention from PR template [skip ci] (#70486) * Remove IE11 mention from PR template * Add link to browser matrix Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-07-06 13:32:55 +02:00
- [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers)
[PROPOSAL] Make Kibana's PR template a checklist (#23511) Kibana now uses a checklist for its PR template. The contributing docs were updated with more detail about release process.
2018-09-28 18:36:31 +02:00
### For maintainers
Update links that pointed to CONTRIBUTING.md (#74757) * Update links that pointed to CONTRIBUTING.md * Update .github/PULL_REQUEST_TEMPLATE.md point to master instead of 7.x
2020-08-11 16:18:12 +02:00
- [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
Reference in a new issue Copy permalink