# Contributing to Scaffold-Stylus (`create-stylus`)

> `create-stylus` is part of the Scaffold-Stylus toolkit

Thank you for your interest in contributing to Scaffold-Stylus! Your support enhances this Arbitrum-focused framework that bridges smart contract integration with web applications.

## About the Project

**Scaffold-Stylus** provides a full DApp development template, offering seamless integration of Stylus smart contracts with web applications. **SpeedrunStylus.com** offers interactive challenges that serve to practice your Rust with Stylus and Arbitrum skills, learn how to use the provided hooks, and launch your applications swiftly with potential rewards.

## Project Vision

Our goal is to simplify the DApp development and learning process, enabling developers to launch applications efficiently while understanding the intricacies of Arbitrum.

## How to Get Involved

1. **Understand the Code**: Begin by familiarizing yourself with the architecture and flow by reading through the documentation provided in the README.md.
2. **Check Issues and Discussions**: Look through existing issues and discussions to understand ongoing problems or feature requests.
3. **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.

## Making Changes

- **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.

## Submitting Contributions

1. **Pull Requests**: Submit a PR to the main repository with a detailed description of your changes.
2. **Review Process**: Engage with any feedback from maintainers to refine your PR.
3. **Tests**: Ensure all tests pass and, if necessary, add new tests relevant to your changes.

## Documentation

If your changes involve updates to how users interact with Scaffold-Stylus or SpeedrunStylus, update the relevant sections of the documentation to reflect these changes.

## Need Help?

Reach out via our community channels if you encounter issues or need clarification on contributing [here](https://t.me/+wO3PtlRAreo4MDI9).
