CONTRIBUTING.md

Contributing to [Project Name]

Thank you for your interest in contributing to our project! We welcome contributions from everyone.

Table of Contents

• Getting Started
• Development Environment
• Making Changes
• Testing
• Pull Request Process
• Style Guide
• Community

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

Getting Started

1. Fork the repository
2. Clone your fork:

   git clone https://github.com/your-username/project-name.git

3. Add the upstream remote:

   git remote add upstream https://github.com/original-owner/project-name.git

Development Environment

1. Install required dependencies:

   curl --proto '=https' --tlsv1.2 -sSf https://docs.swmansion.com/scarb/install.sh | sh
   curl -L https://raw.githubusercontent.com/foundry-rs/starknet-foundry/master/scripts/install.sh | sh

2. Verify installation:

   scarb --version
   snforge --version

3. Install frontend dependencies

   npm install

4. Start the development server

   npm run dev

Making Changes

1. Create a new branch:

   git checkout -b feature/your-feature-name

   or

   git checkout -b fix/issue-number

2. Make your changes

3. Follow the Style Guide

4. Commit your changes:

   git commit -m "Description of changes"

Testing

Before submitting your changes, ensure:

1. All tests pass: /contracts

   snforge test

2. Code is formatted: /contracts

   scarb fmt

   /frontend

   prettier write .

Pull Request Process

1. Update your fork:

   git fetch upstream
   git rebase upstream/main

2. Push your changes:

   git push origin feature/your-feature-name

   or

   git push origin fix/issue-number

3. Open a Pull Request with:

   • Clear title and description
   • Reference to related issues
   • Screenshots/GIFs if applicable
   • Updated documentation

4. Address review feedback

Style Guide

Cairo Code Style

• Follow the official Cairo style guide
• Use meaningful variable names
• Add comments for complex logic
• Include docstrings for functions

Commit Messages

• Use present tense ("Add feature" not "Added feature")
• First line should be:
  • Concise (50 chars or less)
  • Complete sentence
  • Capitalized

Example:

feat: add new component
fix: resolve button click issue
docs: update README

Community

• Join our Discord
• Follow us on Twitter
• Subscribe to our Newsletter

Questions?

Feel free to reach out to the maintainers or open an issue. We're here to help!