Skip to content

Latest commit

 

History

History
69 lines (51 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

69 lines (51 loc) · 1.7 KB

Contributing to QuestLog

Thank you for your interest in contributing to QuestLog! Here's how you can help:

Development Setup

  1. Clone your fork:

    git clone https://github.com/yourusername/QuestLog.git
cd QuestLog

  2. Set up environment:

    # Copy the example environment file
cp example.env .env.test

# Required: Update only these values in .env.test
GOOGLE_CLIENT_ID=your_client_id_from_google_cloud_console
GOOGLE_CLIENT_SECRET=your_client_secret_from_google_cloud_console
REACT_APP_GOOGLE_CLIENT_ID=same_as_GOOGLE_CLIENT_ID

  3. Start the application:

    docker-compose --env-file .env.test up --build

The application will be available at:

All other configuration values in example.env are pre-configured for development.

How to Contribute

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/your-feature)
  3. Make your changes
  4. Run tests if applicable
  5. Commit your changes (git commit -am 'Add new feature')
  6. Push to the branch (git push origin feature/your-feature)
  7. Create a Pull Request

Pull Request Guidelines

  • Keep your changes focused and atomic
  • Update documentation as needed
  • Follow the existing code style
  • Add tests if applicable
  • Describe your changes in the PR description

Bug Reports

Create an issue with:

  • Clear description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • Screenshots if applicable

Questions?

Feel free to create an issue for any questions about contributing.

Code of Conduct

  • Be respectful and inclusive
  • No harassment or discrimination
  • Keep discussions constructive