This is an automated email from the ASF dual-hosted git repository.
bsalzano pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/openserverless.git
The following commit(s) were added to refs/heads/main by this push:
new 35b89ec CONTRIBUTING guidelines and ISSUES templates (#73)
35b89ec is described below
commit 35b89ecab16fb457afc7b96f2e60f984ce13c0c2
Author: Francesco Timperi Tiberi <[email protected]>
AuthorDate: Sun Nov 17 17:43:02 2024 +0100
CONTRIBUTING guidelines and ISSUES templates (#73)
* chore: added contribution guidelines and issues templates
* chore: README update
* chore: fix for typoin asf.yaml
---
.asf.yaml | 2 +-
.github/ISSUE_TEMPLATE/BUG_REPORT.md | 41 ++++++++++++++++++
.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md | 14 ++++++
.github/PULL_REQUEST_TEMPLATE.md | 18 ++++++++
CONTRIBUTING.md | 71 +++++++++++++++++++++++++++++++
README.md | 2 +-
6 files changed, 146 insertions(+), 2 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
index e10def9..bea0c17 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -16,7 +16,7 @@
#
github:
- description: "Apache OpenServerless"
+ description: "Apache OpenServerless (incubating)"
homepage: https://openserverless.apache.org
labels:
- openserverless
diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md
b/.github/ISSUE_TEMPLATE/BUG_REPORT.md
new file mode 100644
index 0000000..26911b7
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md
@@ -0,0 +1,41 @@
+---
+name: Bug Report
+
+about: If you would like to report an issue to OpenServerless, please use this
template.
+
+---
+<!-- Please do not use this issue template to report security vulnerabilities
but refer to our [security
policy](https://github.com/seata/seata/security/policy). -->
+
+- [ ] I have searched the
[issues](https://github.com/apache/openserverless/issues) of this repository
and believe that this is not a duplicate.
+
+### Ⅰ. Issue Description
+
+
+### Ⅱ. Describe what happened
+
+ If there is an exception, please attach the exception trace:
+
+```
+Just paste your stack trace here!
+```
+
+
+### Ⅲ. Describe what you expected to happen
+
+
+### Ⅳ. How to reproduce it (as minimally and precisely as possible)
+
+1. xxx
+2. xxx
+3. xxx
+
+Minimal yet complete reproducer code (or URL to code):
+
+
+### Ⅴ. Anything else we need to know?
+
+### Ⅵ. Environment:
+
+- K8S Runtime and version:
+- OPS CLI version:
+- Others:
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
new file mode 100644
index 0000000..4ab430a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
@@ -0,0 +1,14 @@
+---
+name: Feature Request
+
+about: Suggest an idea for OpenServerless
+
+---
+## Why you need it?
+ Is your feature request related to a problem? Please describe in details
+
+## How it could be?
+A clear and concise description of what you want to happen. You can explain
more about input of the feature, and output of it.
+
+## Other related information
+Add any other context or screenshots about the feature request here.
\ No newline at end of file
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..684e3fb
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,18 @@
+<!-- Please make sure you have read and understood the contributing guidelines
-->
+
+- [ ] I have registered the PR [changes](../changes).
+
+### Ⅰ. Describe what this PR did
+
+
+### Ⅱ. Does this pull request fix one issue?
+<!-- If that, add "fixes #xxx" below in the next line, for example, fixes #97.
-->
+
+
+### Ⅲ. Why don't you add test cases (unit test/integration test)?
+
+
+### Ⅳ. Describe how to verify it
+
+
+### Ⅴ. Special notes for reviews
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..ef3969b
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,71 @@
+<!--
+#
+# 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.
+#
+-->
+[](http://www.apache.org/licenses/LICENSE-2.0)
+
+# Contributing to Apache OpenServerless (incubating)
+
+Anyone can contribute to the OpenServerless project and we welcome your
contributions.
+
+There are multiple ways to contribute: report bugs, improve the docs, and
+contribute code, but you must follow these prerequisites and guidelines:
+
+- [Contributing to Apache OpenServerless
(incubating)](#contributing-to-apache-openserverless-incubating)
+ - [Contributor License Agreement](#contributor-license-agreement)
+ - [Raising issues](#raising-issues)
+ - [Discussion](#discussion)
+ - [Coding standards](#coding-standards)
+
+### Contributor License Agreement
+
+All contributors must sign and submit an Apache CLA (Contributor License
Agreement).
+
+Instructions on how to do this can be found here:
+[http://www.apache.org/licenses/#clas](http://www.apache.org/licenses/#clas)
+
+Sign the appropriate CLA and submit it to the Apache Software Foundation (ASF)
secretary. You will receive a confirmation email from the ASF and be added to
+the following list: http://people.apache.org/unlistedclas.html. Once your
name is on this list, you are done and your PR can be merged.
+
+Project committers will use this list to verify pull requests (PRs) come from
contributors that have signed a CLA.
+
+We look forward to your contributions!
+
+## Raising issues
+
+Please raise any bug reports or enhancement requests on the main project
repository's GitHub [issue
tracker](https://github.com/apache/openserverless/issues). Be sure to search the
+list to see if your issue has already been raised.
+
+A good bug report is one that make it easy for us to understand what you were
trying to do and what went wrong.
+Provide as much context as possible so we can try to recreate the issue.
+
+A good enhancement request comes with an explanation of what you are trying to
do and how that enhancement would help you.
+
+### Discussion
+
+Please use the project's developer email list to engage our community:
+[[email protected]]([email protected])
+
+In addition, we provide a [Telegram](https://t.me/+XhbCjBrkkaNkOWM0) team
channel for conversation and support.
+
+### Coding standards
+
+Please ensure you follow the coding standards used throughout the existing
+code base. Some basic rules include:
+
+ - all files must have the Apache license in the header.
+ - all PRs must have passing builds for all operating systems (where this is
applicable).
\ No newline at end of file
diff --git a/README.md b/README.md
index 990c226..eefb179 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
Welcome to [Apache
OpenServerless](https://cwiki.apache.org/confluence/display/INCUBATOR/OpenServerlessProposal)
(shortened as **AOS**), an incubating project at the [Apache Software
Foundation](https://www.apache.org).
-*NOTE*: This README provides information about how to setup the development
environment of the project, in case you are interested in contributing to the
project or have a better understanding of the it. *If you are interested in
testing and use the platform as it is, refer to the installation instructions
on the project [website](https://openserverless.apache.org).*
+*NOTE*: This README provides how-to setup instructions for the Apache
OpenServerless development. It is mostly addressed to people willing to
contribute to the project or willing to have a better understanding of the
implementations details. *Regular Apache OpenServerless users, should refer to
the official documentation [website](https://openserverless.apache.org).*
## Development Environment Overview
