Contributing Guide

Join us in building Detroit's digital future

We welcome contributions of all sizes from developers of all skill levels. This guide will help you get started with our codebase and contribution process.

Getting Started

Our projects are built with modern web technologies including Next.js, TypeScript, and various backend services. Follow these steps to set up your development environment:

1

Fork the Repository

Visit our GitHub repository and fork it to your own GitHub account.
2

Clone Your Fork

git clone https://github.com/YOUR-USERNAME/regen-art.git
cd regen-art
3

Install Dependencies

npm install
# or
yarn install
4

Start Development Server

npm run dev
# or
yarn dev

Contribution Workflow

We follow a standard GitHub workflow for contributions. Here's how to contribute:

1. Find an Issue

Browse our GitHub Issues to find something to work on, or create a new issue to discuss your ideas.

2. Create a Branch

Create a new branch for your work:
git checkout -b feature/your-feature-name

3. Make Your Changes

Implement your changes, following our code style guidelines. Make sure to write tests for new features.

4. Submit a Pull Request

Push your changes and create a pull request. Provide a clear description of your changes and reference any related issues.

Code Standards

Code Formatting

We use ESLint and Prettier to maintain consistent code style. Run npm run lint before submitting your PR.

Testing

Write tests for new features using Jest and React Testing Library. Run npm test to ensure all tests pass.

Commit Messages

Follow conventional commits format: type(scope): message (e.g., feat(auth): add login page)

Documentation

Update documentation for any new features or changes to existing functionality.

Get Help

Need help with your contribution? We're here to support you!

Join Our Discord

Connect with our community on Discord for real-time help and discussions.

Join Discord

GitHub Discussions

Ask questions and share ideas in our GitHub Discussions forum.

View Discussions