ClickHouse/.github/PULL_REQUEST_TEMPLATE.md

70 lines
2.8 KiB
Markdown
Raw Normal View History

<!---
A technical comment, you are free to remove or leave it as it is when PR is created
The following categories are used in the next scripts, update them accordingly
utils/changelog/changelog.py
tests/ci/cancel_and_rerun_workflow_lambda/app.py
-->
### Changelog category (leave one):
- New Feature
2024-06-21 09:49:26 +00:00
- Experimental Feature
- Improvement
- Performance Improvement
- Backward Incompatible Change
- Build/Testing/Packaging Improvement
- Documentation (changelog entry is not required)
2024-05-28 10:53:52 +00:00
- Critical Bug Fix (crash, LOGICAL_ERROR, data loss, RBAC)
2023-04-19 08:54:45 +00:00
- Bug Fix (user-visible misbehavior in an official stable release)
- CI Fix or Improvement (changelog entry is not required)
- Not for changelog (changelog entry is not required)
2019-11-05 15:03:17 +00:00
### Changelog entry (a user-readable short description of the changes that goes to CHANGELOG.md):
...
2023-01-04 13:05:32 +00:00
### Documentation entry for user-facing changes
2023-01-11 21:26:03 +00:00
- [ ] Documentation is written (mandatory for new features)
2023-01-04 13:10:36 +00:00
<!---
2023-01-04 13:08:31 +00:00
Directly edit documentation source files in the "docs" folder with the same pull-request as code changes
2023-01-04 13:05:32 +00:00
2023-01-04 13:08:31 +00:00
or
2023-01-04 13:08:31 +00:00
Add a user-readable short description of the changes that should be added to docs.clickhouse.com below.
2023-01-04 13:08:31 +00:00
At a minimum, the following information should be added (but add more as needed).
- Motivation: Why is this function, table engine, etc. useful to ClickHouse users?
- Parameters: If the feature being added takes arguments, options or is influenced by settings, please list them below with a brief explanation.
- Example use: A query or command.
-->
2019-11-05 15:03:17 +00:00
2022-04-22 12:09:11 +00:00
> Information about CI checks: https://clickhouse.com/docs/en/development/continuous-integration/
2024-05-31 10:30:40 +00:00
#### CI Settings (Only check the boxes if you know what you are doing):
- [ ] <!---ci_set_required--> Allow: All Required Checks
2024-05-24 10:02:14 +00:00
- [ ] <!---ci_include_stateless--> Allow: Stateless tests
2024-05-24 09:46:50 +00:00
- [ ] <!---ci_include_stateful--> Allow: Stateful tests
2024-05-31 10:30:40 +00:00
- [ ] <!---ci_include_integration--> Allow: Integration Tests
2024-05-24 09:46:50 +00:00
- [ ] <!---ci_include_performance--> Allow: Performance tests
2024-06-10 09:18:03 +00:00
- [ ] <!---ci_set_builds--> Allow: All Builds
- [ ] <!---batch_0_1--> Allow: batch 1, 2 for multi-batch jobs
2024-05-31 10:30:40 +00:00
- [ ] <!---batch_2_3--> Allow: batch 3, 4, 5, 6 for multi-batch jobs
2024-05-24 09:46:50 +00:00
---
2024-05-31 10:01:16 +00:00
- [ ] <!---ci_exclude_style--> Exclude: Style check
2024-05-24 09:46:50 +00:00
- [ ] <!---ci_exclude_fast--> Exclude: Fast test
- [ ] <!---ci_exclude_asan--> Exclude: All with ASAN
2024-05-31 10:30:40 +00:00
- [ ] <!---ci_exclude_tsan|msan|ubsan|coverage--> Exclude: All with TSAN, MSAN, UBSAN, Coverage
2024-06-07 16:15:57 +00:00
- [ ] <!---ci_exclude_aarch64|release|debug--> Exclude: All with aarch64, release, debug
2024-05-24 09:46:50 +00:00
---
2024-07-17 16:19:02 +00:00
- [ ] <!---ci_include_fuzzer--> Run only fuzzers related jobs (libFuzzer fuzzers, AST fuzzers, etc.)
2024-08-13 01:42:47 +00:00
- [ ] <!---ci_exclude_ast--> Exclude: AST fuzzers
---
- [ ] <!---do_not_test--> Do not test
- [ ] <!---woolen_wolfdog--> Woolen Wolfdog
- [ ] <!---upload_all--> Upload binaries for special builds
- [ ] <!---no_merge_commit--> Disable merge-commit
2024-05-31 10:01:16 +00:00
- [ ] <!---no_ci_cache--> Disable CI cache