From def5cf0a1ff66a147b460b4345a5e91ed82f9424 Mon Sep 17 00:00:00 2001 From: Mohammed Sohail Date: Mon, 3 Jan 2022 17:51:53 +0300 Subject: [PATCH] docs: add prereqs, scope and issues section --- CONTRIBUTING.md | 66 +++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 58 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 73d76c43..446461e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,16 +1,66 @@ -Hello and welcome to the CIC Stack repository. Targeted for use with the ethereum virtual machine and a ussd capable telecom provider. +# Contribution Guidelines -__To request a change to the code please fork this repository and sumbit a merge request.__ +**Karibu sana!** Hello and welcome to the Grassroots Economics [project](https://gitlab.com/grassrootseconomics). This guide will help you understand the overall +organization of the CIC project to get you started with contributing to the project. You'll be able to pick up issues, write code to fix them, and get your work reviewed and merged. -__If there is a Grassroots Economics Kanban Issue please include that in our MR it will help us track contributions. Karibu sana!__ +## Table of Contents -__Visit the Development Kanban board here: https://gitlab.com/grassrootseconomics/cic-internal-integration/-/boards/2419764__ +- [Prerequisites](#Prerequisites) +- [Scope of contributions](#Scope-of-contributions) +- [Issues](#Issues) + - [Bugs](#Bugs) + - [Good first issues](#Good-first-issues) +- [Git guidelines](#Git-guidelines) +- [Merge request processs](#Merge-request-processs) +- [Environment setup](#Environment-setup) +- [Code style](#Code-style) +- [Building-and-testing](#Building-and-testing) -__Ask a question in our dev chat:__ +## Prerequisites -[Mattermost](https://chat.grassrootseconomics.net/cic/channels/dev) +Before contributing to the CIC Stack, ensure you have: -[Discord](https://discord.gg/XWunwAsX) +- Read and accepted to abide by the Code of Conduct + +- Read and accepted the Developers Certificate of Origin + -[Matrix, IRC soon?] +## Scope of contributions +We generally welcome all sorts or contributions. No contribution is too small. We gladly accept contributions such as: + +- Documentation improvements including inline documentation or even minor typos +- Answering questions in issue discussions and pull requests +- Fixing known bugs on our issue tracker +- Reporting unknown bugs + +- Securty issues through responsible disclosure + +## Issues + +Use the existing issue template and issue tags to correctly catagorize and issue when creating issues. Make sure to search for duplicated before creating a new issue. + +### Bugs + +If a bug is encountered and you can reproduce it: + +- Define its priority with an issue tag +- Describe the steps to reproduce it while providing the version of the bugged service/library and your environment setup + +### Good first issues + +These are pre-tagged issues which are friendly (low barrier to entry and clearly defined tasks) for new contributors to get aquinted to the project. + +## Git guideleines + + + +## Merge request process + + + +## Environment setup + +## Code style + +## Building and testing