Skip to content

Latest commit

 

History

History
141 lines (105 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

141 lines (105 loc) · 3.06 KB

🤝 Contributing to Repo Radar

First off, thank you for considering contributing to Repo Radar! It's people like you who make Repo Radar such a great tool.

🎯 Ways to Contribute

There are many ways you can contribute to Repo Radar:

  • 🐛 Reporting bugs
  • 💡 Suggesting enhancements
  • 📝 Improving documentation
  • 🔧 Submitting code changes
  • 🎨 Improving UI/UX
  • 🌍 Adding translations

🚀 Getting Started

  1. Fork the Repository

    • Fork the RepoRadar repository
    • Clone the forked repository to your local machine

  2. Create a Branch

    # Make sure you're on main
git checkout main
git pull upstream main

# Create and switch to new branch
git checkout -b feature/your-feature-name

  3. Make Your Changes

    • Write clear, concise commit messages
    • Follow our coding standards
    • Add tests if applicable
    • Update documentation as needed

  4. Submit a Pull Request

    • Push to your fork
    • Create a PR from GitHub
    • Fill out the PR template
    • Link any relevant issues

💻 Development Setup

Backend

cd backend
npm install
cp .env.example .env
# Configure your environment variables
npm run dev

Frontend

cd RepoRadar
npm install
npm run dev

📋 Pull Request Guidelines

Commit Messages

Follow the Conventional Commits specification:

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation changes
  • style: Code style changes
  • refactor: Code refactoring
  • test: Adding tests
  • chore: Maintenance tasks

Code Style

  • Use ESLint and Prettier configurations provided
  • Follow existing code patterns
  • Keep functions small and focused
  • Write meaningful variable names

Testing

  • Add tests for new features
  • Ensure all tests pass
  • Update existing tests if needed

🐛 Bug Reports

When filing an issue, make sure to answer these questions:

  1. What version of Node.js are you using?
  2. What operating system are you using?
  3. What did you do?
  4. What did you expect to see?
  5. What did you see instead?

💡 Feature Requests

Feature requests are welcome! Please provide:

  • Clear use case
  • Expected behavior
  • Why this feature would be useful

📝 Documentation

  • Keep README.md updated
  • Add JSDoc comments to functions
  • Update API documentation
  • Include examples where helpful

🔍 Code Review Process

  1. At least one maintainer must approve
  2. All tests must pass
  3. Documentation must be updated
  4. Code style must be consistent

⚖️ Code of Conduct

Please note that this project is released with a Code of Conduct. By participating in this project you agree to abide by its terms.

🏆 Recognition

Contributors will be:

  • Listed in CONTRIBUTORS.md
  • Mentioned in release notes
  • Credited in documentation

❓ Questions?

Feel free to:

  • Open an issue
  • Start a discussion
  • Reach out to maintainers

Thank you for contributing to Repo Radar! 🙌

Every contribution makes Repo Radar better for everyone!