| 1 | [](http://www.apache.org/licenses/LICENSE-2.0)
|
| 2 | |
| 3 | #
|
| 4 | # Licensed to the Apache Software Foundation (ASF) under one or more contributor
|
| 5 | # license agreements. See the NOTICE file distributed with this work for additional
|
| 6 | # information regarding copyright ownership. The ASF licenses this file to you
|
| 7 | # under the Apache License, Version 2.0 (the # "License"); you may not use this
|
| 8 | # file except in compliance with the License. You may obtain a copy of the License
|
| 9 | # at:
|
| 10 | #
|
| 11 | # http://www.apache.org/licenses/LICENSE-2.0
|
| 12 | #
|
| 13 | # Unless required by applicable law or agreed to in writing, software distributed
|
| 14 | # under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
|
| 15 | # CONDITIONS OF ANY KIND, either express or implied. See the License for the
|
| 16 | # specific language governing permissions and limitations under the License.
|
| 17 | #
|
| 18 | -->
|
| 19 |
|
| 20 | # Contributing to Apache OpenWhisk
|
| 21 |
|
| 22 | Anyone can contribute to the OpenWhisk project and we welcome your contributions.
|
| 23 |
|
| 24 | There are multiple ways to contribute: report bugs, improve the docs, and
|
| 25 | contribute code, but you must follow these prerequisites and guidelines:
|
| 26 |
|
| 27 | - [Contributor License Agreement](#contributor-license-agreement)
|
| 28 | - [Raising issues](#raising-issues)
|
| 29 | - [Coding Standards](#coding-standards)
|
| 30 |
|
| 31 | ### Contributor License Agreement
|
| 32 |
|
| 33 | All contributors must sign and submit an Apache CLA (Contributor License Agreement).
|
| 34 |
|
| 35 | Instructions on how to do this can be found here:
|
| 36 | [http://www.apache.org/licenses/#clas](http://www.apache.org/licenses/#clas)
|
| 37 |
|
| 38 | Once submitted, you will receive a confirmation email from the Apache Software Foundation (ASF) and be added to
|
| 39 | the following list: http://people.apache.org/unlistedclas.html.
|
| 40 |
|
| 41 | Project committers will use this list to verify pull requests (PRs) come from contributors that have signed a CLA.
|
| 42 |
|
| 43 | We look forward to your contributions!
|
| 44 |
|
| 45 | ## Raising issues
|
| 46 |
|
| 47 | Please raise any bug reports on the respective project repository's GitHub issue tracker. Be sure to search the
|
| 48 | list to see if your issue has already been raised.
|
| 49 |
|
| 50 | A good bug report is one that make it easy for us to understand what you were trying to do and what went wrong.
|
| 51 | Provide as much context as possible so we can try to recreate the issue.
|
| 52 |
|
| 53 | ### Discussion
|
| 54 |
|
| 55 | Please use the project's developer email list to engage our community:
|
| 56 | [dev@openwhisk.incubator.apache.org](dev@openwhisk.incubator.apache.org)
|
| 57 |
|
| 58 | In addition, we provide a "dev" Slack team channel for conversations at:
|
| 59 | https://openwhisk-team.slack.com/messages/dev/
|
| 60 |
|
| 61 | ### Coding standards
|
| 62 |
|
| 63 | Please ensure you follow the coding standards used throughout the existing
|
| 64 | code base. Some basic rules include:
|
| 65 |
|
| 66 | - all files must have the Apache license in the header.
|
| 67 | - all PRs must have passing builds for all operating systems.
|