Thank you for your interest in contributing to Scaffold-Stark! Your support enhances this StarkNet-focused framework that bridges smart contract integration with web applications.
Scaffold-Stark provides a full DApp development template, offering seamless integration of StarkNet smart contracts with web applications. SpeedrunStark.com offers interactive challenges that serve to practice your Cairo and StarkNet skills, learn how to use the provided hooks, and launch your applications swiftly with potential rewards.
Our goal is to simplify the DApp development and learning process, enabling developers to launch applications efficiently while understanding the intricacies of StarkNet.
- Understand the Code: Begin by familiarizing yourself with the architecture and flow by reading through the documentation provided in the README.md.
- Check Issues and Discussions: Look through existing issues and discussions to understand ongoing problems or feature requests.
- Start Contributing:
- Fix Issues: Choose an existing issue and work towards a solution.
- Enhance Documentation: Improve instructions, examples, or explanations.
- Develop New Features: Contribute new features that align with our project's goals.
- Branch Out: Always work in a separate branch to avoid conflicts.
- Coding Standards: Follow the coding conventions and maintain the code quality as described in our documentation.
- Commit Messages: Write clear, concise commit messages that describe your changes and their impact.
- Pull Requests: Submit a PR to the main repository with a detailed description of your changes.
- Review Process: Engage with any feedback from maintainers to refine your PR.
- Tests: Ensure all tests pass and, if necessary, add new tests relevant to your changes.
If your changes involve updates to how users interact with Scaffold-Stark or SpeedrunStark, update the relevant sections of the documentation to reflect these changes.
Reach out via our community channels if you encounter issues or need clarification on contributing.