nora/CONTRIBUTING.md

Contributing to NORA

Thanks for your interest in contributing to NORA!

Getting Started

1. Fork the repository
2. Clone your fork:

   git clone https://github.com/your-username/nora.git
   cd nora
   

3. Create a branch:

   git checkout -b feature/your-feature-name
   

Development Setup

Prerequisites

• Rust 1.75+ (rustup update)
• Docker (for testing)
• Git

Build

cargo build

Run

cargo run --bin nora

Test

cargo test
cargo clippy
cargo fmt --check

Making Changes

1. Write code following Rust conventions
2. Add tests for new features
3. Update docs if needed
4. Run checks:

   cargo fmt
   cargo clippy -- -D warnings
   cargo test
   

Commit Messages

Follow Conventional Commits:

• feat: - New feature
• fix: - Bug fix
• docs: - Documentation
• test: - Tests
• refactor: - Code refactoring
• chore: - Maintenance

Example:

git commit -m "feat: add S3 storage migration"

Pull Request Process

1. Push to your fork:

   git push origin feature/your-feature-name
   

2. Open a Pull Request on GitHub

3. Wait for review - maintainers will review your PR

Code Style

• Follow Rust conventions
• Use cargo fmt for formatting
• Pass cargo clippy with no warnings
• Write meaningful commit messages

Questions?

• Open an Issue
• Ask in Discussions
• Reach out on Telegram

---

Built with love by the NORA community