Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (55 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

69 lines (55 loc) · 1.47 KB
Raw

Contributing to Coin.ai

Thank you for your interest in contributing to Coin.ai! This guide will help you get started.

Ways to Contribute

  • Bug Reports
  • Feature Requests
  • Documentation
  • Code Contributions
  • Translations
  • Testing

Before Contributing

  1. Check Existing Issues
  2. Read Guidelines

Getting Started

1. Fork and Clone

git clone https://github.com/your-username/coin.ai.git
cd coin.ai
git remote add upstream https://github.com/Irtesaam/coin.ai.git

2. Create your Branch

git checkout -b feature/your-feature-name
git checkout -b bug/your-bug-name
git checkout -b docs/your-docs-name

3. Set Up Development Environment

See Installation Guide

Coding Standards

Go Backend

React Native Frontend

  • Use TypeScript
  • Follow React hooks guidelines
  • Use functional components

Git Commit Guidelines

Testing Requirements

  • All new code must include tests
  • Aim for >80% code coverage

Submitting Changes

  1. Push your feature branch
  2. Create a Pull Request on GitHub
  3. Fill out the PR template

Code Review Process

  • Automated Checks
  • Peer Review
  • Testing
  • Documentation

Recognition

  • Contributors listed in TEAM.md
  • Acknowledgment in release notes
  • GitHub profile contribution graph

Getting Help