thingsboard/pull_request_template.md

33 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

2022-01-31 09:45:48 +02:00
## Pull Request description
Put your PR description here instead of this sentence.
2022-01-28 16:23:36 +02:00
## General checklist
- [ ] You have reviewed the guidelines [document](https://docs.google.com/document/d/1wqcOafLx5hth8SAg4dqV_LV3un3m5WYR8RdTJ4MbbUM/edit?usp=sharing).
- [ ] [Labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels#about-labels) that classify your pull request have been added.
2022-09-28 11:09:23 +03:00
- [ ] The [milestone](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/about-milestones) is specified and corresponds to fix version.
2022-01-28 16:23:36 +02:00
- [ ] Description references specific [issue](https://github.com/thingsboard/thingsboard/issues).
- [ ] Description contains human-readable scope of changes.
- [ ] Description contains brief notes about what needs to be added to the documentation.
2022-02-02 08:50:17 +02:00
- [ ] No merge conflicts, commented blocks of code, code formatting issues.
2022-01-28 16:23:36 +02:00
- [ ] Changes are backward compatible or upgrade script is provided.
- [ ] Similar PR is opened for PE version to simplify merge. Crosslinks between PRs added. Required for internal contributors only.
2022-01-28 16:23:36 +02:00
2022-01-31 09:45:48 +02:00
## Front-End feature checklist
2022-01-28 16:23:36 +02:00
- [ ] Screenshots with affected component(s) are added. The best option is to provide 2 screens: before and after changes;
2022-02-02 08:50:17 +02:00
- [ ] If you change the widget or other API, ensure it is backward-compatible or upgrade script is present.
2022-01-28 16:23:36 +02:00
- [ ] Ensure new API is documented [here](https://github.com/thingsboard/thingsboard-ui-help)
2022-01-31 09:45:48 +02:00
## Back-End feature checklist
2022-01-28 16:23:36 +02:00
- [ ] Added corresponding unit and/or integration test(s). Provide written explanation in the PR description if you have failed to add tests.
- [ ] If new dependency was added: the dependency tree is checked for conflicts.
- [ ] If new service was added: the service is marked with corresponding @TbCoreComponent, @TbRuleEngineComponent, @TbTransportComponent, etc.
- [ ] If new REST API was added: the RestClient.java was updated, issue for [Python REST client](https://github.com/thingsboard/thingsboard-python-rest-client) is created.
- [ ] If new yml property was added: make sure a description is added (above or near the property).
2022-01-28 16:23:36 +02:00