CONTRIBUTING.md

Contributing to Sure

It means so much that you're interested in contributing to Sure! Seriously. Thank you. The entire community benefits from these contributions!

Getting Started

Before contributing, please read our Project Conventions Rule, which is intended for LLMs, but is also an excellent primer on how we write code for Sure.

• Before contributing, please check if it already exists in issues or PRs
• If you're not sure where to start, check out our good first issues

As we are still in the early days of this project, we recommend heading over to the Wiki to get a better idea of what to contribute.

In general, full features that get us closer to our 🔜 Vision are the most valuable contributions at this stage.

Development Setup

Prerequisites

• Ruby (see .ruby-version)
• PostgreSQL
• Node.js (for frontend tooling)

Quick Start

1. Fork the repository
2. Clone your fork: git clone https://github.com/YOUR_USERNAME/Sure.git
3. Set up the development environment:

   cd Sure
   cp .env.local.example .env.local
   bin/setup
   bin/dev

4. Visit http://localhost:3000

Setup Guides

• Mac Setup Guide
• Linux Setup Guide
• Windows Setup Guide

Making Changes

1. Create a new branch: git checkout -b feature/your-feature-name
2. Make your changes
3. Run tests: bin/rails test
4. Run linters: bin/rubocop and npm run lint
5. Create new Pull Request, and be sure to check the Allow edits from maintainers checkbox
6. Fill out the PR template completely
7. Before requesting a review, please make sure that all Github Checks have passed and your branch is up-to-date with the main branch. After doing so, request a review and wait for feedback.

Code Style

• Follow the existing code style and conventions
• Use meaningful commit messages
• Write tests for new features
• Update documentation as needed

Questions?

If you have questions, feel free to:

• Open a Discussion
• Join our Discord
• Open an Issue

Thank you for contributing to Sure! 🎉