mirror of https://github.com/getnora-io/nora.git synced 2026-04-12 15:00:31 +00:00

Files

DevITWay 7326f9b0e2 chore: add pre-commit hook to prevent sensitive file commits

- Whitelist approach: only known safe extensions allowed (.rs, .toml, .yml, etc.)
- Block sensitive patterns (.env, .key, .pem, secrets, credentials)
- Warn but allow .md files
- Check only NEW files, modifications to tracked files always allowed
- Block large files (>5MB) with warning
- Run cargo fmt check on Rust files
- Update CONTRIBUTING.md with hook setup instructions

2026-01-31 16:39:04 +00:00

1.5 KiB

Raw Blame History

Contributing to NORA

Thank you for your interest in contributing to NORA!

Getting Started

Fork the repository
Clone your fork: git clone https://github.com/YOUR_USERNAME/nora.git
Create a branch: git checkout -b feature/your-feature

Development Setup

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

# Enable pre-commit hooks (important!)
git config core.hooksPath .githooks

# Build
cargo build

# Run tests
cargo test

# Run locally
cargo run --bin nora -- serve

Code Style

Run cargo fmt before committing
Run cargo clippy and fix warnings
Follow Rust naming conventions

Pull Request Process

Update documentation if needed
Add tests for new features
Ensure all tests pass: cargo test
Ensure code is formatted: cargo fmt --check
Ensure no clippy warnings: cargo clippy

Commit Messages

Use conventional commits:

feat: - new feature
fix: - bug fix
docs: - documentation
style: - formatting
refactor: - code refactoring
test: - adding tests
chore: - maintenance

Example: feat: add OAuth2 authentication

Reporting Issues

Use GitHub Issues
Include steps to reproduce
Include NORA version and OS

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Contact

Telegram: @DevITWay
GitHub Issues: getnora-io/nora

1.5 KiB Raw Blame History