From c83ec2ec9a057bd9e081a69723cf448a85643953 Mon Sep 17 00:00:00 2001 From: DammyAji Date: Mon, 29 Jun 2026 11:15:31 +0100 Subject: [PATCH] docs: add LICENSE, CODE_OF_CONDUCT.md, and CONTRIBUTING.md Closes #92 - Add MIT LICENSE file to formally license the project - Add CODE_OF_CONDUCT.md (Contributor Covenant 2.1) - Add root CONTRIBUTING.md linking to module-specific guides - Update README.md with links to CONTRIBUTING.md and CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 127 +++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 131 +++++++++++++++++++++++++++++++++++++++++++++ LICENSE | 21 ++++++++ README.md | 2 + 4 files changed, 281 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..dad1572 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,127 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, including a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional + setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in response +to any behavior that they deem inappropriate, threatening, offensive, or +harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +dammy.aji@example.com. + +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact****: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence****: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact****: A violation through a single incident or series of +actions. + +**Consequence****: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact****: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence****: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact****: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an individual, +or aggression toward or disparagement of classes of individuals. + +**Consequence****: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the Contributor Covenant, +version 2.1, available at +https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. + +Community Impact Guidelines were inspired by +https://github.com/evidence-community/. + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..013039e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,131 @@ +# Contributing to ChainForge + +Thank you for contributing to ChainForge! This document provides an overview of how to contribute to the project. + +## Table of Contents + +- [Code of Conduct](#code-of-conduct) +- [Getting Started](#getting-started) +- [Development Workflow](#development-workflow) +- [Module-Specific Guides](#module-specific-guides) +- [Pull Request Process](#pull-request-process) +- [Community](#community) + +--- + +## Code of Conduct + +This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please be respectful, inclusive, and constructive in all interactions. + +--- + +## Getting Started + +### Prerequisites + +- Node.js 18+ +- pnpm 9.x +- Python 3.11+ (for AI service) +- Rust toolchain with Soroban CLI (for smart contracts) +- Docker (optional, for containerized development) + +### Fork and Clone + +```bash +git clone https://github.com/YOUR_USERNAME/ChainForge.git +cd ChainForge +``` + +### Install Dependencies + +From the repository root: + +```bash +pnpm install +``` + +--- + +## Development Workflow + +### 1. Create a Branch + +Always work on a branch, never directly on `main`: + +```bash +git checkout -b feature/your-feature-name +``` + +Branch naming conventions: +- `feature/*` — New features +- `fix/*` — Bug fixes +- `chore/*` — Tooling and documentation + +### 2. Make Your Changes + +- Follow the coding conventions in each module's contributing guide +- Add or update tests as needed +- Update documentation if you change APIs or add features +- Ensure no secrets, keys, or seed phrases are committed + +### 3. Commit Your Changes + +We follow [Conventional Commits](https://www.conventionalcommits.org/): + +```bash +git add . +git commit -m "feat(frontend): add campaign creation dialog" +``` + +### 4. Push and Open a PR + +```bash +git push origin feature/your-feature-name +``` + +--- + +## Module-Specific Guides + +Each service in the `app/` directory has its own contributing guide with detailed instructions: + +| Service | Guide | Description | +|---|---|---| +| Smart Contracts | [app/onchain/CONTRIBUTING.md](app/onchain/CONTRIBUTING.md) | Rust + Soroban contracts | +| Backend | [app/backend/CONTRIBUTING.md](app/backend/CONTRIBUTING.md) | NestJS API server | +| Frontend | [app/frontend/CONTRIBUTING.md](app/frontend/CONTRIBUTING.md) | Next.js admin dashboard | +| Mobile | [app/mobile/CONTRIBUTING.md](app/mobile/CONTRIBUTING.md) | Expo React Native app | + +Before contributing to a specific module, read its contributing guide for setup instructions and validation requirements. + +--- + +## Pull Request Process + +### Before Opening a PR + +- [ ] Branch is up-to-date with `main` +- [ ] All validation checks pass locally +- [ ] New features include tests where applicable +- [ ] Documentation updated + +### PR Description + +Include in your PR description: + +- **What changed** — Brief summary of the change and why it's needed +- **How to run** — Setup steps if different from standard workflow +- **Test logs** — Output from local test runs +- **Closes** — Reference to any related issue (`Closes #92`) + +--- + +## Community + +- **Questions:** Open a [GitHub Discussion](https://github.com/ChainForge/ChainForge/discussions) +- **Bugs:** Open a [GitHub Issue](https://github.com/ChainForge/ChainForge/issues) +- **Documentation:** Check the root [README.md](README.md) first + +--- + +Thank you for contributing to making humanitarian aid delivery more transparent and efficient! \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..96577a0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 ChainForge Team + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 34fd9dd..31a0dbf 100644 --- a/README.md +++ b/README.md @@ -152,6 +152,8 @@ We welcome contributions that make humanitarian aid delivery more transparent an 4. Ensure no secrets, keys, or seed phrases are committed 5. Follow the coding conventions and style guides documented in each service's README +For detailed contribution guidelines, see our [CONTRIBUTING.md](CONTRIBUTING.md) guide. Please also review our [Code of Conduct](CODE_OF_CONDUCT.md). + For component-specific contribution guidelines, refer to the README in each `app/` subdirectory. ---