Skip to content

Commit 5c204ed

Browse files
BigLepclaude
andauthored
docs: add CONTRIBUTING.md and AGENTS.md (#134)
* docs: add CONTRIBUTING.md and AGENTS.md Add contribution guidelines covering conventional commits, issue references, visual evidence for changes, draft PR workflow, and code quality standards. Add AGENTS.md to ensure AI tools follow contribution guidelines. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> * docs: improve CONTRIBUTING.md structure and link from README - Reorganize CONTRIBUTING.md with clearer section structure - Add Contributing section to README.md linking to CONTRIBUTING.md - List key contribution topics (commit conventions, PR workflow, code quality) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> * Slight readme updates --------- Co-authored-by: Claude <[email protected]>
1 parent 52f1985 commit 5c204ed

File tree

3 files changed

+50
-0
lines changed

3 files changed

+50
-0
lines changed

AGENTS.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# AI Agent Guidelines
2+
3+
When using AI agents (such as Claude Code, Cursor, or similar tools) to contribute to this project, please ensure the agent follows all guidelines outlined in [CONTRIBUTING.md](./CONTRIBUTING.md).
4+
5+
This includes:
6+
- Using conventional commits
7+
- Referencing GitHub issues in PRs
8+
- Including visual evidence for user-facing changes
9+
- Keeping PRs in draft until ready for review
10+
- Writing concise, self-documenting code

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing to filecoin-pin
2+
3+
Thank you for your interest in contributing! Please follow these guidelines when submitting changes.
4+
5+
## Use Conventional Commits
6+
7+
All commits, especially PR titles, should follow the [Conventional Commits](https://www.conventionalcommits.org/) specification:
8+
9+
- `feat:` - New features
10+
- `fix:` - Bug fixes
11+
- `docs:` - Documentation changes
12+
- `chore:` - Maintenance tasks
13+
- `refactor:` - Code refactoring
14+
- `test:` - Test additions or changes
15+
- `ci:` - CI/CD changes
16+
17+
Example: `feat: add support for batch uploads`
18+
19+
## Reference GitHub Issues
20+
21+
Always reference the related GitHub issue in your PR description using keywords like `Fixes #123` or `Closes #456`.
22+
23+
### Include Visual Evidence
24+
25+
For user-facing changes or CLI flows, include:
26+
- Screenshots for UI changes
27+
- Terminal output for CLI commands
28+
- Before/after comparisons when relevant
29+
30+
## Draft PRs
31+
32+
Leave your PR in draft status until it's ready for maintainer review. This helps maintainers prioritize their time.
33+
34+
## Code Quality
35+
36+
Keep comments concise and favor self-documenting code when possible. Use clear variable names, function names, and code structure to make your intent obvious.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,10 @@ npm run lint:fix # Fix formatting
203203

204204
## Community and Support
205205

206+
### Contributing
207+
208+
Interested in contributing? Please read our [Contributing Guidelines](CONTRIBUTING.md) for information on commit conventions, PR workflows, etc.
209+
206210
### Get Help
207211

208212
- **Issues**: Found a bug or have a feature request? [Open an issue](https://github.com/filecoin-project/filecoin-pin/issues) in this repository

0 commit comments

Comments
 (0)