You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by go...@apache.org on 2021/07/20 04:52:26 UTC

[incubator-inlong] branch master updated: [INLONG-768] add github pull request template (#566)

This is an automated email from the ASF dual-hosted git repository.

gosonzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-inlong.git


The following commit(s) were added to refs/heads/master by this push:
     new cdf6e75  [INLONG-768] add github pull request template (#566)
cdf6e75 is described below

commit cdf6e752a087390d4168d6b08da4d198f1ad0345
Author: dockerzhang <do...@apache.org>
AuthorDate: Tue Jul 20 12:52:19 2021 +0800

    [INLONG-768] add github pull request template (#566)
    
    Co-authored-by: dockerzhang <do...@tencent.com>
---
 .github/PULL_REQUEST_TEMPLATE.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..7a270b9
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,36 @@
+Fixes [Jira Issue](https://issues.apache.org/jira/projects/INLONG/issues): issue_address
+
+### Motivation
+
+*Explain here the context, and why you're making that change. What is the problem you're trying to solve.*
+
+### Modifications
+
+*Describe the modifications you've done.*
+
+### Verifying this change
+
+- [ ] Make sure that the change passes the CI checks.
+
+*(Please pick either of the following options)*
+
+This change is a trivial rework / code cleanup without any test coverage.
+
+*(or)*
+
+This change is already covered by existing tests, such as *(please describe tests)*.
+
+*(or)*
+
+This change added tests and can be verified as follows:
+
+*(example:)*
+  - *Added integration tests for end-to-end deployment with large payloads (10MB)*
+  - *Extended integration test for recovery after broker failure*
+
+### Documentation
+
+  - Does this pull request introduce a new feature? (yes / no)
+  - If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)
+  - If a feature is not applicable for documentation, explain why?
+  - If a feature is not documented yet in this PR, please create a followup issue for adding the documentation