From d11fe267645faf422b5dededd2b5731c3abe6891 Mon Sep 17 00:00:00 2001 From: kaumini Date: Thu, 28 Nov 2019 15:46:36 +0530 Subject: [PATCH] Add CONTRIBUTING.md --- CONTRIBUTING.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..507a9b0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,49 @@ +# Contributing to Kubernetes and Helm Resources for WSO2 Open Banking + +This repository includes Kubernetes and Helm Resources for WSO2 Open Banking. We encourage contributions from our community. + +## How you can Contribute + +### Mailing Lists + +The recommended way to discuss anything related to WSO2 products is via our mailing lists. First, go to https://wso2.com/mail/ and subscribe to any mailing lists. Here are the two most popular lists: + +* dev@wso2.org: To discuss all WSO2 products. +* architecture@wso2.org: To discuss the architecture of WSO2 products. + +### Posting Issues + +We encourage you to report any problems in the WSO2 product Kubernetes and Helm Resources or their documentation by creating GitHub issues in the respective repositories. +The issues page on GitHub is for tracking bugs and feature requests. When posing a new issue, follow the guidelines below. + +* Check whether the issue has already been reported. +* Create a separate issue for each bug you are reporting or feature you are requesting. + +### Code Contributions + +If you like to contribute with a bug fix or a new feature, start by posting an issue and discussing the best way to implement it. + +Unlike most projects, development for this repository is carried out on the `1.4.x` branch. This is because the `master` branch contains the latest stable release of the project. +The code in `1.4.x` is merged to the `master` branch after a final review and a round of testing. + +Please follow these guidelines when contributing to the code: + +1. Fork the current repository. +2. Create a topic branch from the `1.4.x` branch. +3. Make commits in logical units. +4. Before you send out the pull request, sync your forked repository with a remote repository. This makes your pull request simple and clear. + +```bash +git clone https://github.com//kubernetes-open-banking.git +git remote add upstream https://github.com/wso2/kubernetes-open-banking.git +git fetch upstream +git checkout -b upstream/1.4.x + +# add some work + +git push origin + +# submit pull request +``` + +**Thanks for contributing!**