Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
115 lines (77 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

115 lines (77 loc) · 2.13 KB
Raw

Contributing to DocuGen

Thank you for your interest in contributing to DocuGen! This document provides guidelines and instructions for contributing.

Getting Started

Prerequisites

  • Node.js 18+
  • npm 9+
  • Git

Development Setup

  1. Fork the repository on GitHub
  2. Clone your fork locally: 
    git clone https://github.com/YOUR_USERNAME/docugen.git
cd docugen
  3. Install dependencies: 
    npm install
  4. Start the development server: 
    npm run dev
  5. Open http://localhost:3000 in your browser

Development Workflow

1. Create a Branch

Create a new branch for your feature or bugfix:

git checkout -b feature/your-feature-name

2. Make Changes

Make your changes following the code style guidelines in AGENTS.md.

3. Test Your Changes

Run the test suite to ensure your changes don't break existing functionality:

npm run test:run

4. Lint and Format

Ensure your code passes linting and formatting checks:

npm run lint      # Check for issues
npm run format    # Auto-format code

5. Build

Verify the project builds successfully:

npm run build

6. Commit Your Changes

Commit your changes with a clear commit message:

git add .
git commit -m "Add feature: your feature description"

7. Push and Create PR

Push your branch and create a Pull Request:

git push origin feature/your-feature-name

Then open a Pull Request on GitHub.

Code Style Guidelines

Please follow the guidelines in AGENTS.md for:

  • TypeScript conventions
  • Component structure
  • Tailwind CSS usage
  • Testing practices
  • Git commit messages

Reporting Issues

When reporting issues, please include:

  1. A clear description of the problem
  2. Steps to reproduce the issue
  3. Expected behavior vs actual behavior
  4. Screenshots (if applicable)
  5. Browser/OS information

Code of Conduct

This project follows our Code of Conduct. By participating, you are expected to uphold this code.

Questions?

If you have questions, feel free to open an issue for discussion.