Skip to content

Latest commit

 

History

History
104 lines (74 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

104 lines (74 loc) · 2.84 KB

Contributing to AgentStack

Thank you for your interest in contributing to AgentStack! Every contribution earns you $AGENT tokens through our on-chain attribution system.

🎁 Rewards

Contribution Type Tokens Earned
Merged PR (small) 10 AGENT
Merged PR (large) 50 AGENT
Bug report with fix 20 AGENT
Documentation improvement 5 AGENT
Security vulnerability 100-500 AGENT

Tokens are minted to your wallet address after your contribution is merged.

🛠️ Development Setup

# Clone the repo
git clone https://github.com/jaredtribe/agentstack.git
cd agentstack

# Install dependencies
npm install

# Run in development mode
npm run dev

# Run tests
npm test

📝 Making Changes

  1. Fork the repository
  2. Create a branch for your feature (git checkout -b feature/amazing-feature)
  3. Make your changes with clear, descriptive commits
  4. Add tests if applicable
  5. Update documentation if needed
  6. Submit a Pull Request

🧪 Code Standards

  • TypeScript strict mode enabled
  • Use meaningful variable names
  • Add JSDoc comments for public APIs
  • Keep functions small and focused
  • Write tests for new functionality

📋 Pull Request Process

  1. Fill out the PR template completely
  2. Link any related issues
  3. Ensure CI passes
  4. Request review from maintainers
  5. Address feedback promptly

💰 Claiming Rewards

When your PR is merged:

  1. Provide your wallet address in the PR description or CONTRIBUTORS.md
  2. Maintainers will verify the contribution per ATTRIBUTION_PROTOCOL.md
  3. Tokens are minted via the DAO contract after 7-day review period
  4. You'll receive a notification when tokens are sent

Important: We follow strict attribution verification to prevent hallucinated credits. Your contribution must be:

  • Verifiable via git commits or PR evidence
  • Linked to your confirmed wallet address
  • Free of disputes during review period

See ATTRIBUTION_PROTOCOL.md for full details.

🐛 Reporting Bugs

Please include:

  • Clear description of the bug
  • Steps to reproduce
  • Expected vs actual behavior
  • Environment details (Node version, OS, etc.)

💡 Feature Requests

We welcome ideas! Please:

  • Check existing issues first
  • Describe the use case clearly
  • Explain the expected benefit

🔒 Security

If you discover a security vulnerability:

  • DO NOT open a public issue
  • Email security@agentstack.dev
  • Include detailed description and reproduction steps
  • Allow 48 hours for initial response

📜 License

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

🙏 Thank You!

Your contributions make AgentStack better for the entire AI agent ecosystem. Together, we're building the future of decentralized agent collaboration.