Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
362 lines (253 loc) · 7.83 KB

CONTRIBUTING.md

File metadata and controls

362 lines (253 loc) · 7.83 KB

Contributing to GitHub Mastery 🤝

Help us build the definitive GitHub automation toolkit!

Ajude-nos a construir o toolkit definitivo de automação do GitHub!

🇧🇷 Português | 🇪🇸 Español | 🇺🇸 English

🌟 Welcome Contributors!

Thank you for your interest in contributing to GitHub Mastery! This project aims to become the most comprehensive toolkit for GitHub automation, and your contributions are essential to achieving this goal.

🚀 Quick Start for Contributors

  1. Fork the repository
  2. Clone your fork locally
  3. Create a feature branch
  4. Make your changes
  5. Test your changes (when testing suite is available)
  6. Submit a Pull Request

📋 Ways to Contribute

🐛 Bug Reports

  • Use the issue template
  • Include reproduction steps
  • Provide environment details
  • Add screenshots if relevant

💡 Feature Requests

  • Describe the use case
  • Explain the expected behavior
  • Consider implementation complexity
  • Check existing issues first

🔧 Code Contributions

  • Follow our coding standards
  • Add tests for new features
  • Update documentation
  • Keep PRs focused and small

📚 Documentation

  • Fix typos and grammar
  • Improve examples
  • Add missing documentation
  • Translate to other languages

🛠️ Development Setup

Prerequisites

# Required tools
- Node.js >= 18.0.0
- npm or yarn
- Git
- GitHub Personal Access Token

Local Development

# Clone your fork
git clone https://github.com/YOUR_USERNAME/github-mastery.git
cd github-mastery

# Install dependencies
npm install

# Setup environment
cp .env.example .env
# Add your GitHub token

# Start development
npm run dev

📏 Code Standards

JavaScript/Node.js

  • Use ESLint configuration provided
  • Follow Prettier formatting
  • Use meaningful variable names
  • Add JSDoc comments for functions
  • Handle errors properly

Git Conventions

# Commit message format
type(scope): description

# Types
feat:     New feature
fix:      Bug fix
docs:     Documentation
style:    Formatting
refactor: Code restructuring
test:     Adding tests
chore:    Maintenance

Examples

feat(cli): add bulk repository operations
fix(webhook): resolve HMAC verification issue
docs(api): update authentication guide

🔍 Pull Request Process

  1. Update Documentation: Include relevant docs
  2. Add Tests: When testing framework is available
  3. Follow Conventions: Use conventional commits
  4. Keep It Small: Focus on single feature/fix
  5. Describe Changes: Clear PR description

PR Template Checklist

  • Follows coding standards
  • Includes tests (when applicable)
  • Updates documentation
  • Follows commit conventions
  • Resolves linked issue

🧪 Testing (Coming Soon)

When our testing suite is ready:

# Run tests
npm test

# Run with coverage
npm run test:coverage

# Run linting
npm run lint

# Run all validations
npm run validate

🌍 Internationalization

We support multiple languages:

  • English: Primary documentation
  • Português: Complete translation
  • Others: Welcome contributions!

Contribuindo em Português 🇧🇷

Bem-vindos contribuidores brasileiros e lusófonos! Sua participação é fundamental para tornar este projeto verdadeiramente inclusivo.

🎯 Como Contribuir

🐛 Relatórios de Bug

  • Use o template de issue
  • Inclua passos para reprodução
  • Forneça detalhes do ambiente
  • Adicione screenshots se relevante

💡 Solicitações de Funcionalidade

  • Descreva o caso de uso
  • Explique o comportamento esperado
  • Considere a complexidade de implementação
  • Verifique issues existentes primeiro

🔧 Contribuições de Código

  • Siga nossos padrões de código
  • Adicione testes para novas funcionalidades
  • Atualize a documentação
  • Mantenha PRs focados e pequenos

🛠️ Configuração de Desenvolvimento

# Clone seu fork
git clone https://github.com/SEU_USUARIO/github-mastery.git
cd github-mastery

# Instale dependências
npm install

# Configure o ambiente
cp .env.example .env
# Adicione seu token GitHub

# Inicie desenvolvimento
npm run dev

📏 Padrões de Código

Convenções Git

# Formato da mensagem de commit
tipo(escopo): descrição

# Tipos
feat:     Nova funcionalidade
fix:      Correção de bug
docs:     Documentação
style:    Formatação
refactor: Reestruturação de código
test:     Adição de testes
chore:    Manutenção

Exemplos

feat(cli): adicionar operações em massa de repositórios
fix(webhook): resolver problema de verificação HMAC
docs(api): atualizar guia de autenticação

🔍 Processo de Pull Request

  1. Atualize Documentação: Inclua docs relevantes
  2. Adicione Testes: Quando framework de teste estiver disponível
  3. Siga Convenções: Use commits convencionais
  4. Mantenha Pequeno: Foque em uma funcionalidade/correção
  5. Descreva Mudanças: Descrição clara do PR

Contribuyendo en Español 🇪🇸

¡Bienvenidos contribuyentes hispanohablantes! Su participación es fundamental para hacer este proyecto verdaderamente inclusivo.

🎯 Cómo Contribuir

🐛 Reportes de Errores

  • Usa la plantilla de issue
  • Incluye pasos para reproducir
  • Proporciona detalles del entorno
  • Añade capturas de pantalla si es relevante

💡 Solicitudes de Funcionalidad

  • Describe el caso de uso
  • Explica el comportamiento esperado
  • Considera la complejidad de implementación
  • Verifica issues existentes primero

🔧 Contribuciones de Código

  • Sigue nuestros estándares de código
  • Añade pruebas para nuevas funcionalidades
  • Actualiza la documentación
  • Mantén los PRs enfocados y pequeños

🛠️ Configuración de Desarrollo

# Clona tu fork
git clone https://github.com/TU_USUARIO/github-mastery.git
cd github-mastery

# Instala dependencias
npm install

# Configura el entorno
cp .env.example .env
# Añade tu token de GitHub

# Inicia desarrollo
npm run dev

📏 Estándares de Código

Convenciones Git

# Formato del mensaje de commit
tipo(alcance): descripción

# Tipos
feat:     Nueva funcionalidad
fix:      Corrección de error
docs:     Documentación
style:    Formateo
refactor: Reestructuración de código
test:     Añadir pruebas
chore:    Mantenimiento

Ejemplos

feat(cli): añadir operaciones en lote de repositorios
fix(webhook): resolver problema de verificación HMAC
docs(api): actualizar guía de autenticación

🔍 Proceso de Pull Request

  1. Actualiza Documentación: Incluye docs relevantes
  2. Añade Pruebas: Cuando el framework de pruebas esté disponible
  3. Sigue Convenciones: Usa commits convencionales
  4. Mantenlo Pequeño: Enfócate en una funcionalidad/corrección
  5. Describe Cambios: Descripción clara del PR

🤔 Questions?

  • English: Open an issue or discussion
  • Português: Abra uma issue ou discussão
  • General: Check existing documentation first

📄 Code of Conduct

This project follows the Contributor Covenant. By participating, you agree to uphold this code.

Our Standards

✅ Positive Environment

  • Respectful communication
  • Constructive feedback
  • Inclusive language
  • Professional behavior

❌ Unacceptable Behavior

  • Harassment or discrimination
  • Trolling or insulting comments
  • Personal attacks
  • Spam or off-topic content

Thank you for contributing to GitHub Mastery! 🚀

Obrigado por contribuir com o GitHub Mastery! 🚀

🏠 Homepage • 📖 Docs • 🐛 Issues