From 193dc6d8290a238218d6132ffe5e68f6b0e921cc Mon Sep 17 00:00:00 2001 From: adelcasse Date: Thu, 31 Oct 2024 18:46:48 +0000 Subject: [PATCH] Describe how to contribute --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0eef5d1..2bc0bf5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ -# contributing +# Contributing -Contributing guidelines to the COOPGO Technical Platform and other applications. \ No newline at end of file +We're very happy that you consider to contribute to our open source projects ! Cooperation is at the heart of COOPGO values and we're can't wait to see your improvements to our projects. + +This page describe some guidelines to have your contributions included. + +## How to contribute + +To contribute to COOPGO open source projects, you need to : + +1. Sign a Contributor Licence Agreement (CLA). If you are an indvidual contributing as yourself, please use the [Individual Contributor Licence Agreement](contributor_agreements/individual_cla.pdf). If you are an employee and have created the contribution as part of your employment, please use the [Corporate Contributor Licence Agreement](contributor_agreements/corporate_cla.pdf). +2. Send the CLA to us by email (tech@coopgo.io) +3. Wait for approvement. Once approved, we will give us access to our source control system on https://git.coopgo.io. +4. Fork the main repository of the project you're willing to contribute to, within your personal organization on https://git.coopgo.io +5. Discuss the changes you're willing to make with COOPGO team through the tickets system +6. Commit your changes on your personal organization +7. Once your contribution is ready, please make a pull request with sufficient information for COOPGO team to make a review + +## Licence + +By default, if not stated otherwise in the source repositories of the project itself, the licence applied to any material is AGPL version 3 or later. \ No newline at end of file