Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
243 lines (177 loc) · 4.66 KB

CONTRIBUTING.md

File metadata and controls

243 lines (177 loc) · 4.66 KB
Raw

Contributing Guide

Welcome to the Stellar Tip Jar Frontend project! We're excited to have you contribute. This guide will help you get started.

Getting Started

Prerequisites

  • Node.js >= 20.0.0
  • npm or pnpm
  • Git

Setup

  1. Fork the repository

    # Visit https://github.com/Bonizozo/stellar-tipjar-frontend and click "Fork"

  2. Clone your fork

    git clone https://github.com/YOUR_USERNAME/stellar-tipjar-frontend.git
cd stellar-tipjar-frontend

  3. Install dependencies

    npm install
# or
pnpm install

  4. Create a branch

    git checkout -b feature/your-feature-name

  5. Make your changes

    # Edit files as needed

  6. Run tests

    npm run test
npm run test:e2e

  7. Commit your changes

    git commit -m "feat: add your feature"

  8. Push to your fork

    git push origin feature/your-feature-name

  9. Create a Pull Request

    • Visit your fork on GitHub
    • Click "New Pull Request"
    • Fill in the PR template
    • Submit!

Code Style

TypeScript

  • Use TypeScript for all new code
  • Avoid any types; use proper typing
  • Export types from component files

ESLint & Prettier

# Run linting
npm run lint

# Type checking
npm run typecheck

Naming Conventions

  • Components: PascalCase (e.g., UserProfile.tsx)
  • Hooks: camelCase with use prefix (e.g., useUserData.ts)
  • Utilities: camelCase (e.g., formatDate.ts)
  • Constants: UPPER_SNAKE_CASE (e.g., MAX_RETRIES)

Commit Convention

We follow Conventional Commits:

<type>(<scope>): <subject>

<body>

<footer>

Types

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that don't affect code meaning (formatting, etc.)
  • refactor: Code change that neither fixes a bug nor adds a feature
  • perf: Code change that improves performance
  • test: Adding or updating tests
  • chore: Changes to build process, dependencies, etc.

Examples

git commit -m "feat(auth): add two-factor authentication"
git commit -m "fix(wallet): resolve connection timeout issue"
git commit -m "docs: update API integration guide"

Testing

Unit Tests

npm run test

E2E Tests

npm run test:e2e
npm run test:e2e:ui  # Interactive mode

Coverage

npm run test -- --coverage

Pull Request Process

  1. Update documentation if needed
  2. Add tests for new features
  3. Ensure all tests pass
  4. Keep commits clean and descriptive
  5. Link related issues in PR description
  6. Request review from maintainers

Code Review Guidelines

When reviewing code:

  • Check for TypeScript compliance
  • Verify tests are included
  • Ensure documentation is updated
  • Look for performance issues
  • Check accessibility (a11y)
  • Verify security best practices

Project Structure

src/
├── app/              # Next.js App Router routes
├── components/       # Reusable React components
├── hooks/           # Custom React hooks
├── lib/             # Utilities and libraries
├── services/        # API service layer
├── contexts/        # React contexts
├── types/           # TypeScript type definitions
├── utils/           # Helper functions
└── styles/          # Global styles

Common Tasks

Adding a New Component

  1. Create file in src/components/
  2. Use TypeScript with proper types
  3. Add JSDoc comments
  4. Export from component index if needed
  5. Add tests in __tests__/ folder

Adding a New Hook

  1. Create file in src/hooks/
  2. Prefix with use
  3. Add TypeScript types
  4. Document with JSDoc
  5. Add tests if complex logic

Adding a New API Endpoint

  1. Add method to src/services/api.ts
  2. Use proper error handling
  3. Add TypeScript types
  4. Document with JSDoc
  5. Add tests

Troubleshooting

Build Issues

# Clear cache and reinstall
rm -rf node_modules package-lock.json
npm install
npm run build

Type Errors

npm run typecheck

Linting Issues

npm run lint -- --fix

Resources

Questions?

  • Check existing issues and discussions
  • Ask in pull request comments
  • Open a new discussion

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing! 🚀