Thank you for your interest in contributing to the Surfer Protocol! We welcome contributions from the community to help improve and expand this project.
- Adding new platforms in the desktop app and documentation (see Guide to Adding New Platforms)
- Building applications off of Surfer Protocol (see Python SDK and Cookbook)
- Helping with the documentation website (see Docs)
- General Bug Fixes
Please see our Setup Guide for more information on how to set up the development environment.
-
Reporting Bugs: If you encounter any bugs or issues, please open a new issue in the GitHub repository. Provide a clear and detailed description of the problem, along with any relevant steps to reproduce the issue.
-
Suggesting Features: If you have an idea for a new feature or improvement, please open a new issue in the GitHub repository. Describe the feature in detail, explain its benefits, and provide any additional context that might be helpful.
-
Submitting Pull Requests: If you would like to contribute code changes to the project, follow these steps:
- Fork the repository
- Create a new branch for your feature or bug fix
- Make your changes
- Test your changes thoroughly
- Submit a pull request to the main repository, providing a clear description of your changes and the problem they solve
We appreciate all contributions, whether they are bug reports, feature suggestions, or code changes. By working together, we can make Surfer a better and more useful tool for everyone.
If you have any questions or need further assistance, please feel free to reach out to the project maintainers:
Surfer Discord Server - @SahilLalani0 - @JackBlair87 - @T0M_3D