From a18baf4aa8155fe2ae0350f7850095be9ba54c46 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabio=20Jos=C3=A9?= Date: Sun, 16 Jun 2019 20:05:44 -0300 Subject: [PATCH] Closes #20: contributing guidelines MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabio José --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ README.md | 4 ++++ 2 files changed, 32 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c981286 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Contributing to CloudEvents' JavaScript SDK + +:+1::tada: First off, thanks for taking the time to contribute! :tada::+1: + +Following you will see some guidelines about how to contribute with +JavaScript SDK. + +## Pull Requests + +Guidelines about how to perform pull requests. + +### PR to `develop` + +- fixes in the documentation (readme, contributors) +- propose new files for documentation +- implementation of new features + +### PR to `master` + +- hot fixes + +## Style Guide + +_TODO_ + +### JavaScript Style Guide + +_TODO_ diff --git a/README.md b/README.md index a931bd3..a7cb1d7 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,10 @@ Official CloudEvents' SDK for JavaScript. CloudEvents logo +## Contributing + +Before create an awesome PR, please read our [guidelines](./CONTRIBUTING.md). + ## Versioning ### Before Spec reaches 1.0