mirror of
https://github.com/jmcorgan/fips.git
synced 2026-07-22 07:48:26 +00:00
92d5df8037
Add standard open-source project files for public repository presentability: - README.md with protocol overview, Nostr identity integration, feature highlights, quick start, and project structure - MIT LICENSE (Copyright 2026 Johnathan Corgan) - CONTRIBUTING.md with guidelines for issues, PRs, and testing - Cargo.toml metadata (description, license, authors, repository, readme) - .gitignore expanded with editor/IDE patterns and .claude/
34 lines
816 B
Markdown
34 lines
816 B
Markdown
# Contributing to FIPS
|
|
|
|
## Getting Started
|
|
|
|
Clone the repo and verify your setup:
|
|
|
|
```
|
|
git clone https://github.com/jmcorgan/fips.git
|
|
cd fips
|
|
cargo build
|
|
cargo test
|
|
```
|
|
|
|
Read [docs/design/](docs/design/) for protocol understanding, starting with
|
|
[fips-intro.md](docs/design/fips-intro.md).
|
|
|
|
## Filing Issues
|
|
|
|
- Search existing issues before opening a new one.
|
|
- Include FIPS version, Rust version, and OS.
|
|
- For bugs: steps to reproduce, expected vs actual behavior.
|
|
|
|
## Pull Requests
|
|
|
|
- All PRs must pass `cargo build`, `cargo test`, and `cargo clippy` with no
|
|
warnings.
|
|
- Keep commits focused — one logical change per commit.
|
|
- Add tests for new functionality.
|
|
- Reference relevant design docs if the change touches protocol behavior.
|
|
|
|
## Questions
|
|
|
|
Open a GitHub issue for design or implementation questions.
|