Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
99 lines (70 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

99 lines (70 loc) · 2 KB

Contributing to GPT Rewriter

Thank you for your interest in contributing to GPT Rewriter! 🎉

How to Contribute

This repository uses a fork-based workflow. This means you cannot directly push to this repository, but you can fork it and submit pull requests.

Step 1: Fork the Repository

  1. Click the "Fork" button at the top right of this repository page
  2. This creates a copy of the repository in your GitHub account

Step 2: Clone Your Fork

git clone https://github.com/YOUR_USERNAME/GPTRewriter.git
cd GPTRewriter

Step 3: Create a Branch

git checkout -b feature/your-feature-name

Step 4: Make Your Changes

  • Make your changes to the code
  • Test thoroughly
  • Follow the existing code style
  • Update documentation if needed

Step 5: Commit Your Changes

git add .
git commit -m "Description of your changes"

Step 6: Push to Your Fork

git push origin feature/your-feature-name

Step 7: Create a Pull Request

  1. Go to your fork on GitHub
  2. Click "New Pull Request"
  3. Select the base repository: alshimo/GPTRewriter
  4. Select your branch
  5. Fill out the pull request description
  6. Submit the pull request

Development Setup

  1. Install dependencies:

    npm install

  2. Start development:

    npm run dev

  3. Run linter:

    npm run lint

  4. Fix linting issues:

    npm run fix-lint

Code Style

  • Follow the existing TypeScript/React patterns
  • Use functional components
  • Keep code clean and well-commented
  • Follow the ESLint configuration

Pull Request Guidelines

  • Provide a clear description of your changes
  • Reference any related issues
  • Ensure all tests pass (if applicable)
  • Update documentation as needed
  • Keep pull requests focused on a single feature or fix

Questions?

If you have questions or need help, feel free to:

  • Open an issue for discussion
  • Check existing issues and pull requests

Thank you for contributing! 🙏