First off, thanks for taking the time to contribute to the sc-template! ❤️ Your efforts help build a strong, collaborative environment for developing robust smart contracts.
If you have a question, please make sure to go through our Documentation first. Many common questions are already answered there.
For questions that remain unanswered, feel free to ask by:
- Opening an Issue with a detailed description of your query.
- Joining our community discussions on Discord or Telegram.
When contributing to this project, you agree that you have authored 100% of the content, have the necessary rights to the content, and that the content you contribute can be provided under the project license.
A detailed bug report plays a crucial role in improving the sc-template. Before submitting a bug report:
- Ensure you're using the latest version.
- Verify if it's a real bug and not an error on your side by consulting the documentation.
- Search both open and closed issues to avoid duplicates.
To submit a bug report, open an issue and include as much relevant information as possible.
We welcome suggestions for enhancements, including new features or improvements to existing ones. Before submitting:
- Ensure you're using the latest version.
- Check the documentation to see if the enhancement is already implemented.
- Search existing issues to avoid duplicates.
To suggest an enhancement, open an issue with a clear title and detailed description.
Ready to contribute code? Great! Here are some steps to get you started:
- Fork the repository and create your branch from
main. - Write clear, concise, and functional code that adheres to our styleguides.
- Ensure your changes are thoroughly tested, especially for critical paths.
- Submit a pull request with a detailed description of your changes.
Good documentation is crucial for any project. To contribute:
- Identify gaps or inaccuracies in our existing documentation.
- Propose changes that make the documentation clearer and more comprehensive.
- Submit a pull request with your proposed changes.
Our styleguides ensure consistency and quality across the codebase and documentation. Please review the Solidity Style Guide and JavaScript Style Guide before contributing.
Use clear, concise commit messages that describe the changes you've made. Follow these commit message conventions.
Interested in becoming a more integral part of the sc-template team? Great! Start by consistently contributing to the project, and don't hesitate to reach out to us on Discord or Telegram to express your interest.
We deeply value each contribution to Biconomy, whether it's through optimizing our smart contracts, enhancing security, or other valuable improvements. Noteworthy contributions may qualify for bounties, as outlined in our GAS_OPTIMIZATION.md and SECURITY.md, and contributors will be celebrated in our Contributor Hall of Fame. Contributions that fall outside direct optimization or security enhancements but are deemed valuable by our team may also be eligible for recognition and rewards. Let's work together to build a more secure and efficient ecosystem.
This contributing guide is inspired by the open-source community and aims to foster a welcoming and collaborative environment. We're excited to see your contributions – let's build something great together!