This is an automated email from the ASF dual-hosted git repository. rabbah pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/incubator-openwhisk-composer.git
The following commit(s) were added to refs/heads/master by this push: new a74cb99 more boilerplate: fix DISCLAIMER; add CONTRIBUTING (#2) a74cb99 is described below commit a74cb99e36aab0a32ac1a868b49b237c5902215d Author: David Grove <dgrove-...@users.noreply.github.com> AuthorDate: Thu Oct 4 10:54:56 2018 -0400 more boilerplate: fix DISCLAIMER; add CONTRIBUTING (#2) --- CONTRIBUTING.md | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ DISCLAIMER.txt | 2 +- README.md | 7 ++++-- 3 files changed, 77 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..cf5d5b2 --- /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. +# +--> + +[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0) + +# Contributing to Apache OpenWhisk + +Anyone can contribute to the OpenWhisk 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: + + - [Contributor License Agreement](#contributor-license-agreement) + - [Raising issues](#raising-issues) + - [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) + +Once submitted, you will receive a confirmation email from the Apache Software Foundation (ASF) and be added to +the following list: http://people.apache.org/unlistedclas.html. + +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 respective project repository's GitHub issue tracker. 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: +[d...@openwhisk.incubator.apache.org](d...@openwhisk.incubator.apache.org) + +In addition, we provide a "dev" Slack team channel for conversations at: +https://openwhisk-team.slack.com/messages/dev/ + +### 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. diff --git a/DISCLAIMER.txt b/DISCLAIMER.txt index 65d2a55..aa67e53 100644 --- a/DISCLAIMER.txt +++ b/DISCLAIMER.txt @@ -1 +1 @@ -Apache OpenWhisk Deployment on Kubernetes is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it doe [...] +Apache OpenWhisk Composer is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that [...] diff --git a/README.md b/README.md index da2d59b..6cf928d 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ # --> -# @ibm-functions/composer +# Apache OpenWhisk Composer [![Travis](https://travis-ci.org/ibm-functions/composer.svg?branch=master)](https://travis-ci.org/ibm-functions/composer) [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) @@ -44,7 +44,10 @@ This repository includes: ## Installation -Composer is distributed as Node.js package. To install this package, use the +Composer is distributed as Node.js package. The package is currently named `@ibm-functions/composer`, +but will soon be available as `@openwhisk-composer`. Until we have our first official Apache release of +composer, please continue to use the latest release of `@ibm-functions/composer`. +To install this package, use the Node Package Manager: ``` npm install -g @ibm-functions/composer