Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (59 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

82 lines (59 loc) · 1.88 KB

Contributing to steg.fun 🌟

Thank you for your interest in contributing to steg.fun! We're excited to have you join our community.

📝 Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please be welcoming, friendly, and patient.

🚀 Getting Started

  1. Fork the repository
  2. Clone your fork:
git clone https://github.com/your-username/steg.fun
cd steg.fun
  1. Create a new branch:
git checkout -b feature/your-feature-name

🔧 Development Setup

  1. Make sure you have Docker and Docker Compose installed
  2. Start the development server:
docker-compose up -d
  1. Visit http://localhost:8000

📋 Pull Request Process

  1. Update the README.md with details of changes if needed
  2. Follow the existing code style and formatting
  3. Write clear commit messages
  4. Test your changes locally
  5. Create a Pull Request with a clear title and description

🎨 Style Guide

  • Use meaningful variable and function names
  • Add comments for complex logic
  • Follow the existing project structure
  • Keep functions small and focused
  • Write self-documenting code where possible

✅ Before Submitting

  • Code follows style guidelines
  • Tests pass (if applicable)
  • Documentation is updated
  • Commits are properly formatted
  • Branch is up to date with main

🐛 Reporting Bugs

When reporting bugs, please include:

  • A clear description of the issue
  • Steps to reproduce
  • Expected behavior
  • Screenshots if applicable
  • Browser/environment details

💡 Feature Requests

We love new ideas! Please provide:

  • Clear description of the feature
  • Use cases
  • Expected behavior
  • Any implementation ideas

📝 License

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

Thank you for helping make steg.fun better! 🙏