Contributing Guide

Thank you for your interest in contributing to NCN Network v2! This guide will help you get started.

---

Ways to Contribute

Code Contributions

• Bug fixes

• New features

• Performance improvements

• Documentation updates

Non-Code Contributions

• Bug reports

• Feature requests

• Documentation improvements

• Community support

---

Getting Started

1. Fork the Repository

# Fork on GitHub, then clone your fork
git clone https://github.com/neurochainai/ncn-network-v2-rs.git
cd ncn-network-v2-rs

2. Set Up Development Environment

# Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Install additional tools
rustup component add clippy rustfmt

# Build project
cargo build

# Run tests
cargo test --all

3. Create a Branch

git checkout -b feature/my-feature
# or
git checkout -b fix/my-bugfix

4. Make Changes

Follow the Code Style Guide.

5. Submit Pull Request

See Pull Request Guide.

---

Contributing Guides

Code Style

Coding standards and conventions:

• Rust style guide

• Formatting with cargo fmt

• Linting with cargo clippy

• Documentation standards

Pull Requests

PR process and guidelines:

• Branch naming conventions

• Commit message format

• PR template

• Review process

Documentation

Documentation contribution guide:

• Writing style

• Markdown conventions

• Adding new documents

---

Development Workflow

1. Fork & Clone
       │
       ▼
2. Create Branch
       │
       ▼
3. Make Changes ←───┐
       │            │
       ▼            │
4. Run Tests       │
       │            │
       ▼            │
5. Fix Issues ──────┘
       │
       ▼
6. Commit
       │
       ▼
7. Push to Fork
       │
       ▼
8. Create PR
       │
       ▼
9. Address Review Comments
       │
       ▼
10. Merge! 🎉

---

Code of Conduct

Our Standards

• Be respectful and inclusive

• Welcome newcomers

• Provide constructive feedback

• Focus on the best outcome for the project

Unacceptable Behavior

• Harassment or discrimination

• Personal attacks

• Trolling or insulting comments

• Publishing private information

---

Issue Guidelines

Bug Reports

Include:

1. Description: What happened?

2. Expected: What should have happened?

3. Steps to reproduce: How can we reproduce it?

4. Environment: OS, versions, configuration

5. Logs: Relevant error messages

Feature Requests

Include:

1. Problem: What problem does this solve?

2. Solution: What's your proposed solution?

3. Alternatives: What alternatives did you consider?

4. Impact: Who benefits from this?

---

Quick Commands

# Build
cargo build

# Test
cargo test --all

# Format code
cargo fmt

# Lint code
cargo clippy

# Build docs
cargo doc --open

# Run specific component
cargo run --bin gateway_node

---

Questions?

• Check existing issues and documentation

• Ask in community channels

• Open a discussion on GitHub

We appreciate all contributions! 🙏