Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (52 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

71 lines (52 loc) · 1.66 KB

Contributing to ClawBird

Thank you for your interest in contributing to ClawBird! This document provides guidelines for contributing to the project.

🚀 Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/clawbird.git
  3. Create a branch: git checkout -b feature/your-feature-name
  4. Make your changes
  5. Test your changes: npm test
  6. Commit: git commit -m "Add: your feature description"
  7. Push: git push origin feature/your-feature-name
  8. Open a Pull Request

📝 Commit Message Guidelines

  • feat: - New feature
  • fix: - Bug fix
  • docs: - Documentation changes
  • test: - Adding tests
  • refactor: - Code refactoring
  • perf: - Performance improvements
  • chore: - Maintenance tasks

🧪 Testing

All contributions should include tests. Run the test suite:

npm test
npm run test:actions
npm run test:workflows

🐛 Bug Reports

When filing an issue, please include:

  • Node.js version
  • Browser version
  • Operating system
  • Steps to reproduce
  • Expected vs actual behavior
  • Error messages/logs

💡 Feature Requests

We welcome feature requests! Please:

  • Check if the feature already exists
  • Describe the use case
  • Explain why it would be valuable

🎨 Code Style

  • Use ESLint configuration
  • Follow existing code patterns
  • Add JSDoc comments for public APIs
  • Keep functions focused and small

📄 License

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

🤝 Code of Conduct

  • Be respectful and inclusive
  • Welcome newcomers
  • Focus on constructive feedback
  • Respect different viewpoints

Thank you for contributing! 🎉