Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
107 lines (79 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

107 lines (79 loc) · 2.33 KB

Contributing to epicpast Projects

Thank you for your interest in contributing! This document provides guidelines for contributing to repositories in the epicpast organization.

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Set up the development environment (see repository-specific README)
  4. Create a feature branch
  5. Make your changes
  6. Submit a pull request

How to Contribute

Reporting Bugs

Before submitting:

  1. Search existing issues
  2. Check documentation
  3. Test with latest version

Include in your report:

  • Clear title and description
  • Steps to reproduce
  • Expected vs actual behavior
  • Environment details
  • Error messages/logs
  • Minimal reproducible example

Suggesting Features

Before submitting:

  1. Search existing issues/discussions
  2. Consider project scope
  3. Think through implementation

Include:

  • Problem statement
  • Proposed solution
  • Alternatives considered
  • Additional context

Pull Request Process

  1. Create an issue first for significant changes
  2. Fork and create a feature branch
  3. Make focused, small changes
  4. Write or update tests
  5. Update documentation
  6. Follow code style guidelines
  7. Write clear commit messages
  8. Submit and complete the PR template

Development Guidelines

Code Style

  • Follow existing patterns in the codebase
  • Write clear, readable code
  • Prefer simple solutions
  • Document public APIs

Commit Message Conventions

We follow Conventional Commits:

<type>[scope]: <description>

[body]

[footer]

Types:

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation
  • style: Formatting
  • refactor: Code restructuring
  • perf: Performance improvement
  • test: Test changes
  • build: Build system
  • ci: CI configuration
  • chore: Other changes
  • revert: Revert commit

Code Review

All submissions require review:

  1. CI must pass
  2. At least one maintainer approval
  3. Address all feedback
  4. Final approval and merge

For Reviewers: Be constructive, explain reasoning, distinguish required vs suggested changes.

For Contributors: Respond to all comments, push fixes as new commits, ask for clarification when needed.

Community

  • Questions: GitHub Discussions or issues
  • Security issues: See SECURITY.md
  • Stay updated: Watch repositories

Thank you for contributing!