Skip to content

Commit 843e134

Browse files
committed
chore: add CHANGELOG and CONTRIBUTING
1 parent 8306d88 commit 843e134

2 files changed

Lines changed: 38 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Changelog
2+
3+
All notable changes to this project are documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [v0.1.0]
9+
10+
Initial release.

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing
2+
3+
Thanks for your interest in contributing to `docs` — Pilot Protocol design docs — specs, runbooks, whitepaper, IETF drafts, research papers.
4+
5+
## Quick start
6+
7+
```bash
8+
git clone https://github.com/pilot-protocol/docs.git
9+
cd docs
10+
# review markdown locally
11+
```
12+
13+
## Pull requests
14+
15+
1. Open an issue first for non-trivial changes so design can be discussed.
16+
2. Branch off `main`; keep changes focused and self-contained.
17+
3. Tests are required for new behavior; passing CI is required to merge.
18+
4. Coverage should not regress (Codecov reports per-PR delta).
19+
5. Conventional commit style is preferred (`feat:`, `fix:`, `docs:`, `chore:`, …) but not enforced.
20+
21+
## Code of conduct
22+
23+
Be respectful and constructive. Project maintainers will moderate.
24+
25+
## License
26+
27+
By contributing you agree your contributions will be released under the
28+
project's license (AGPL-3.0-or-later — see `LICENSE`).

0 commit comments

Comments
 (0)