Custos-Starknet Smart Contract Contributor Guidelines

Thank you for your interest in contributing to the Custos-Starknet project! This repository contains the smart contracts for Custos, written in Cairo using Scarb. We appreciate contributions of all types, whether it’s a bug fix, new feature, or improvement to our documentation. Please follow the guidelines below to ensure a smooth contribution process.

Table of Contents

• Code of Conduct
• How to Contribute
• Development Environment Setup
• Project Setup
• Testing Guidelines
• Branching and Commit Guidelines
• Pull Requests
• Workflow Examples
• Coding Standards
• Issue Reporting
• Resources
• License

---

Code of Conduct

Please adhere to our Code of Conduct. We expect all contributors to maintain professionalism and respect when engaging with the community.

---

How to Contribute

There are several ways to contribute to Custos-Starknet:

• Report Bugs: Open an issue to report bugs.
• Suggest Features: Open an issue to suggest new features.
• Fix Bugs or Implement Features: Check open issues and submit a pull request with your contributions.
• Improve Documentation: Enhancing documentation is always welcome.

---

Development Environment Setup

Prerequisites

i. Rust Installation(required for Scarb)

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source $HOME/.cargo/env

ii. Scarb Installation

• For macOS/Linux:

  curl --proto '=https' --tlsv1.2 -sSf https://docs.swmansion.com/scarb/install.sh | sh

• For Windows:

  • Download the installer from Scarb releases
  • Add Scarb to your system PATH

Development Tools

1. VS Code Extensions(recommended)

• Cairo Language Support
• Scarb Build Tools
• Better TOML

---

Project Setup

To contribute, you need to set up the project locally:

1. Fork the repository.
2. Clone your fork:

   git clone https://github.com/your-username/custos-starknet.git

3. Navigate to the project directory:

   cd custos-starknet

4. Install Scarb if you haven't already: Scarb Installation Guide.
5. Install Project Dependencies:

   scarb build

6. Run tests:

   scarb test

7. Make sure everything works before making changes.

---

Testing Guidelines

Running Tests

scarb test

Writing Tests

#[test]
fn test_something() {
   // Arrange
   // Act
   // Assert
}

Test Naming Convention

• Use descriptive names.
• Example: test_deposit_with_valid_amount_succeeds

---

Branching and Commit Guidelines

• Branch Naming:

  • feature/your-feature-name for new features.
  • bugfix/issue-number-description for bug fixes.

• Commit Messages:

  • Use clear, concise messages that describe what the commit does.
  • Example:

    feat: add new collateralization feature for loan contracts

---

Pull Requests

• Ensure your branch is up to date with the main branch.
• Push your changes and open a PR against master.
• Provide a detailed description of your changes.
• Link any relevant issues.

---

Workflow Examples

Adding a New Feature

1. Create feature branch:

   git checkout -b feature/<new-feature-name>

2. Implement feature and tests:

   # Write your code 
   # Add tests
   scarb test

3. Submit PR:

   git add .
   git commit -m "feat: add new feature description"
   git push origin feature/<new-feature-name>

Fixing a Bug

1. Create bug fix branch:

   git checkout -b bugfix/issue-number-description

2. Fix and Verify:

   # Fix the bug
   # Add/modify test
   scarb test

3. Submit PR:

   git add .
   git commit -m "fix: resolve issue description"
   git push origin bugfix/issue-number-description

---

Coding Standards

• Cairo Code: Follow the Cairo documentation and best practices.
• Testing: Write tests for your code and ensure all tests pass before submitting a PR.

---

Issue Reporting

When reporting issues:

• Use descriptive titles.
• Provide as much detail as possible.
• Include relevant environment information.

---

Resources

• Cairo Documentation
• Scarb Documentation