Skip to content

Latest commit

 

History

History
52 lines (31 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

52 lines (31 loc) · 2.66 KB

Welcome to Scaffold-ETH-STARK Contributing Guide

Thank you for investing your time in contributing to Scaffold-ETH-STARK! Your support enhances this multichain-focused framework especially for evm chains and starknet.

This guide aims to provide an overview of the contribution workflow to help us make the contribution process effective for everyone involved.

About the Project

Scaffold-ETH-STARK is a multichain template that combines Scaffold-ETH 2 and Scaffold-Stark. It streamlines the development process and offers seamless interaction with applications built on Starknet and EVM chains.

Read the README to get an overview of the project.

Vision

The goal of Scaffold-ETH-STARK is to simplify the development of multichain applications and launch applications efficiently by providing a unified framework that seamlessly integrates with both Starknet and EVM chains.

Project Status

The project is under active development.

You can view the open Issues, follow the development process and contribute to the project.

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.

Issues should be used to report problems, request a new feature, or discuss potential changes before a PR is created.

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-ETH-Stark, 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.