From 65479df208ed12e66ab6cf3fcf44839d1be524d3 Mon Sep 17 00:00:00 2001 From: rachealmuchiri Date: Sat, 21 Oct 2023 14:20:32 +0300 Subject: [PATCH] added a CONTRIBUTING.md file --- CONTRIBUTING.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..b0189f7a3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,51 @@ +# Contributing to Moja Global's Land Sector Data Analysis + +Thank you for your interest in contributing to the Moja Global's Land Sector Data Analysis project. Your contributions help us analyze and utilize valuable open-source datasets for the betterment of our global community. This guide will walk you through the process of contributing to our project. + +## 1. Getting Started + +### 1.1 The Land Sector Dataset + +The Moja Global's Land Sector Dataset is a collection of publicly available Open source datasets. You have the freedom to choose any dataset from this collection to work on for your analysis. Please note that each dataset comes with its own content and licensing terms. Make sure to read and adhere to the licensing terms of the dataset you select before proceeding with your analysis. + +If you have another dataset in mind that aligns with Moja Global's mission, we encourage you to share the details of this dataset with us by reaching out to [info@moja.global](mailto:info@moja.global). + +### 1.2 Data Analysis Software and Notebooks + +We recommend using data analysis software and notebooks for your work. Notebooks are documents that combine code and rich text elements to make your analysis both human-readable and executable. Select software that supports geospatial analysis as this is aligned with Moja Global's objectives. + +We encourage open-source practices, so please use tools and software that allow you to share your code and results effectively. We recommend using a notebook for your analysis, and you can use platforms like Google Colab. + +## 2. Contributing Process + +When you have completed your data analysis and are ready to contribute to the project, follow these steps: + +### 2.1 Raise a Pull Request (PR) + +1. Fork this repository to your GitHub account. +2. Clone your forked repository to your local machine. +3. Create a new branch for your analysis work. +4. Perform your analysis, write your code, and document your findings in a notebook. +5. Commit your changes to your branch. +6. Push your branch to your forked repository on GitHub. +7. Create a Pull Request (PR) to the original Moja Global repository. + +### 2.2 PR Guidelines + +When creating a PR, please adhere to the following guidelines: + +- Provide a clear and informative title for your PR. +- Include a description of the dataset you worked on and the objectives of your analysis. +- Attach the notebook containing your code and analysis. +- Mention any specific licensing or attribution requirements for the dataset you used. +- Be open to feedback and be willing to make necessary revisions to your contribution. + +## 3. Community and Mentorship + +If you are new to open-source development or need guidance, we encourage you to reach out to us. We offer mentorship and support to new developers and contributors. You can contact us at [mentorship@moja.global](mailto:mentorship@moja.global) for assistance and more information. + +Your contributions make a difference, and we appreciate your dedication to the Moja Global Land Sector Data Analysis project. Thank you for being a part of our community! + +For more information and resources, please visit our [community website](https://community.moja.global/community/code-contribution). + +We look forward to your contributions and collaboration in our open-source project. Thank you for your support and dedication.