Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

55 lines (33 loc) · 2.56 KB

Contributing to the Maia DAO Ecosystem SDKs

Welcome to the Maia DAO Ecosystem SDKs project! We appreciate your interest in contributing to our open-source project.

How to Contribute

We welcome contributions in the form of bug reports, feature requests, code contributions, documentation improvements, and more. To get started, please follow the guidelines below.

Reporting Bugs

If you find a bug in the SDK, please open a GitHub issue with the following information:

  • A clear and descriptive title.
  • A detailed description of the bug, including any error messages.
  • Steps to reproduce the bug.
  • Information about the environment where the bug occurred (e.g., operating system, Node.js version, etc.).

Requesting Features

If you have an idea for a new feature or enhancement, please open a GitHub issue with the following details:

  • A clear and concise description of the feature.
  • Any relevant use cases or examples.

Code Contributions

We welcome code contributions in the form of pull requests (PRs). To contribute code, follow these steps:

  1. Fork the repository to your GitHub account.
  2. Create a new branch from the main branch for your feature or bug fix: git checkout -b feature/your-feature or git checkout -b bugfix/your-bug-fix.
  3. Implement your changes and test thoroughly.
  4. Ensure your code follows the project's coding style and conventions.
  5. Write clear and meaningful commit messages.
  6. Push your changes to your fork: git push origin feature/your-feature or git push origin bugfix/your-bug-fix.
  7. Open a pull request to the main branch.

Our maintainers will review your PR, provide feedback, and work with you to get it merged.

Code Style

Please follow the existing code style and conventions in the project. If you're adding new code, make sure it aligns with the existing codebase.

Documentation

Contributions to documentation are highly valuable. If you find areas in the documentation that can be improved or if you'd like to add new documentation, please feel free to submit PRs.

Code of Conduct

Please note that we have a Code of Conduct in place to ensure a respectful and inclusive community. By contributing to this project, you agree to abide by the Code of Conduct. Be kind and considerate in your interactions with others.

Questions and Assistance

If you have questions or need assistance with contributing, don't hesitate to reach out to us through our discord server: https://discord.gg/maiadao.

We appreciate your contributions and look forward to your involvement in the Maia DAO Ecosystem SDKs project! 🚀