You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by wi...@apache.org on 2020/06/10 11:34:24 UTC
[incubator-streampipes-extensions] branch dev updated:
[STREAMPIPES-161] Add PR template and contributing guide
This is an automated email from the ASF dual-hosted git repository.
wiener pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-streampipes-extensions.git
The following commit(s) were added to refs/heads/dev by this push:
new 39bdcbb [STREAMPIPES-161] Add PR template and contributing guide
new d4af0e4 Merge pull request #24 from grainier/STREAMPIPES-161
39bdcbb is described below
commit 39bdcbb2eeb6e8377485010cd6e24ec591ec2f57
Author: Grainier <gr...@wso2.com>
AuthorDate: Wed Jun 10 15:32:33 2020 +0530
[STREAMPIPES-161] Add PR template and contributing guide
---
.github/PULL_REQUEST_TEMPLATE.md | 35 +++++++++++++++++++++++++++++++++++
CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++
2 files changed, 65 insertions(+)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..4d3c70a
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,35 @@
+<!--
+Thanks for contributing! Here are some tips you can follow to help us incorporate your contribution quickly and easily:
+1. If this is your first time, please read our contributor guidelines:
+ - https://streampipes.apache.org/getinvolved.html
+ - https://cwiki.apache.org/confluence/display/STREAMPIPES/Getting+Started
+2. Make sure the PR title is formatted like: `[STREAMPIPES-<Jira issue #>] PR title ...`
+3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., `[WIP][STREAMPIPES-<Jira issue #>] PR title ...`.
+4. Please write your PR title to summarize what this PR proposes/fixes.
+5. Be sure to keep the PR description updated to reflect all changes.
+6. If possible, provide a concise example to reproduce the issue for a faster review.
+7. Make sure tests pass via `mvn clean install`.
+8. (Optional) If the contribution is large, please file an Apache ICLA
+ - http://apache.org/licenses/icla.pdf
+-->
+
+### Purpose
+<!--
+Please clarify what changes you are proposing and describe how those changes will address the issue.
+-->
+
+### Approach
+<!--
+Describe how you are implementing the solutions along with the design details.
+-->
+
+### Samples
+<!--
+Provide high-level details about the samples related to this feature.
+-->
+
+### Remarks
+<!--
+List related issues/PRs, link to discussions in the mailing list, todo items, or any other notes related to the PR.
+-->
+Fixes: <Jira issue link>
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..6d7d95f
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,30 @@
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+
+## Contributing to StreamPipes
+
+*Before opening a pull request*, review the [Get Involved](https://streampipes.apache.org/getinvolved.html) page.
+It lists information that is required for contributing to StreamPipes.
+
+When you contribute code, you affirm that the contribution is your original work and that you
+license the work to the project under the project's open source license. Whether or not you
+state this explicitly, by submitting any copyrighted material via pull request, email, or
+other means you agree to license the material under the project's open source license and
+warrant that you have the legal authority to do so.
+
+---