Contributing Guidelines

Welcome to edwin's contributing guide! We're excited to have you join our community of contributors helping to build the future of DeFAI.

Ways to Contribute

There are many ways you can contribute to edwin:

1. Code Contributions

   • Protocol integrations

   • Framework adapters

   • Core functionality improvements

   • Security enhancements

   • Bug fixes

2. Documentation

   • Technical documentation

   • Tutorials and guides

   • Code examples

   • API documentation

3. Community Support

   • Answering questions in Discord/Telegram

   • Creating educational content

   • Reporting bugs

   • Suggesting features

Getting Started

1. Fork the edwin repository

2. Clone your fork locally

3. Create a new branch for your contribution

4. Make your changes

5. Submit a pull request

Development Guidelines

Code Style

• Use TypeScript for all new code

• Follow existing code formatting patterns

• Include comprehensive comments

• Write clear commit messages

Testing

• Add tests for new functionality

• Ensure all existing tests pass

• Include both unit and integration tests where applicable

Documentation

• Update relevant documentation for changes

• Add JSDoc comments for new functions

• Include code examples where helpful

Pull Request Process

1. Branch Naming

   • feature/description for new features

   • fix/description for bug fixes

   • docs/description for documentation changes

2. PR Description

   • Clear description of changes

   • Reference any related issues

   • List breaking changes if any

   • Include testing steps

3. Review Process

   • PRs require at least one reviewer

   • Address review feedback promptly

   • Keep PRs focused and manageable in size

Airdrop Eligibility

Contributors may be eligible for the edwin token airdrop. Qualifying contributions include:

• Meaningful code contributions

• Protocol integrations

• Core functionality enhancements

• Security improvements

• Significant documentation improvements

For more details on airdrop eligibility, see our tokenomics page.

Community Guidelines

• Be respectful and inclusive

• Help others when you can

• Follow the code of conduct

• Engage constructively in discussions

Getting Help

If you need assistance:

• Join our Discord

• Ask in our Telegram

• Check existing documentation

• Open a GitHub issue

Security

• Report security vulnerabilities privately

• Follow responsible disclosure practices

• Never commit sensitive credentials

• Review the security model

Thank you for contributing to edwin! Together, we're building the foundation for autonomous DeFi agents.