edwin-sdk

# Contributing to Edwin Thank you for your interest in contributing to Edwin! We welcome everyone—from complete beginners to seasoned experts—to help shape this project. --- ## Contribution License Agreement By contributing to Edwin, you accept that your contributions will be released under the MIT License. This implies: 1. You grant a perpetual, worldwide, non-exclusive, royalty-free license to use your work. 2. Your contributions will be publicly available as Free and Open Source Software (FOSS). 3. You are authorized to submit the work under this license. 4. You acknowledge that your contributions are recorded and remain accessible indefinitely. --- ## How to Contribute ### For Developers 1. **Extend Edwin's Capabilities** - Create new actions and protocols - Improve existing modules and components 2. **Improve Infrastructure** - Tackle open issues and submit pull requests - Update and verify documentation - Enhance performance - Refine deployment methods 3. **Fork and Branch** - Fork the repository and branch off from `main`. - Name the branch with the issue number and a short description (e.g., `9999--add-test-for-bug-123`). 4. **Add Tests** - If you introduce or modify functionality, add the necessary tests. 5. **Test and Lint** - Ensure that the full test suite passes. - Verify that your code follows linting requirements. 6. **Open a Pull Request** - Finally, open a pull request with a clear description of your changes. --- ## Style Guides ### Git Commit Messages - Use present tense (e.g., "Add feature" not "Added feature"). - Use imperative mood ("Move cursor to..." not "Moves cursor to..."). - Limit the first line to 72 characters or fewer. - Reference any relevant issues or pull requests after the first line. ### JavaScript Style Guide - Follow [JavaScript Standard Style](https://standardjs.com/). ### TypeScript Style Guide - Follow [TypeScript Standard Style](https://github.com/standard/ts-standard). ### Documentation Style Guide - Use [Markdown](https://daringfireball.net/projects/markdown/) for all documentation. --- ## Additional Notes ### Issue and Pull Request Labels We categorize issues and PRs with labels to maintain clarity: - `bug` – Indicates a reported error or glitch - `enhancement` – Suggests a new feature or improvement - `Documentation` – Concerns documentation updates or fixes - `good first issue` – Recommended for new contributors --- ## Getting Help - Join our [Discord](https://discord.gg/QNA55N3KtF) community - Submit a GitHub issue if you can't find your answer --- ## Additional Resources - [Gitbook](https://docs.edwin.finance/) --- ### Code of Conduct Our full Code of Conduct can be found in the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file. #### Our Pledge We are committed to maintaining an open, welcoming environment. As contributors and maintainers, we pledge to keep our community free from harassment, regardless of age, body size, disability, ethnicity, gender identity, education level, nationality, personal appearance, race, religion, or sexual identity and orientation. #### Our Standards Positive behaviors include: - Using respectful, inclusive language - Being mindful of different perspectives - Embracing constructive criticism - Prioritizing community well-being - Demonstrating empathy Unacceptable behaviors include: - Sexualized language or imagery and unwelcome advances - Trolling, insults, or personal/political attacks - Harassment in public or private - Sharing private information without permission - Other conduct deemed inappropriate for a professional environment #### Our Responsibilities Project maintainers are responsible for clarifying these standards and will take fair, appropriate action in response to any violations. They may remove, edit, or reject content that does not align with this Code of Conduct and may ban contributors for repeated or severe misconduct. #### Scope This Code of Conduct applies within all project areas and in public spaces when someone is acting on behalf of the project or its community—such as via official email, social media channels, or at public events. Thank you for contributing to Edwin and helping us build the future of DeFAI! 🎉