CONTRIBUTING.md

Contributing to nestjs-metrics-reporter

🎉 Thank you for considering contributing to nestjs-metrics-reporter! This document outlines the basics you need to know.

Ways to Contribute

• Report Bugs: Open an issue describing the bug and include steps to reproduce it
• Suggest Features: Open an issue describing your proposed feature
• Submit Changes: Fork the repo and submit a PR
• Improve Docs: Fix typos, clarify explanations, add examples

Development Process

1. Fork and clone the repository

   git clone https://github.com/your-username/nestjs-metrics-reporter.git

2. Create a feature branch

   git checkout -b feature/your-feature
   # or
   git checkout -b fix/your-fix

3. Make your changes and test

   npm install
   npm run test
   npm run lint: fix

4. Commit your changes using semantic commits

   # Features
   git commit -m "feat: add new feature"
   
   # Bug fixes
   git commit -m "fix: resolve issue"
   
   # Documentation
   git commit -m "docs: update readme"

5. Push and open a PR

   git push origin feature/your-feature

Pull Request Guidelines

• Update documentation if needed
• Add tests for new features
• Maintain existing code style
• Keep changes focused and atomic
• Ensure all tests pass

Getting Help

• 📝 Check existing issues and documentation
• 💬 Open a discussion for questions
• 📧 Contact maintainers if stuck

License

By contributing, you agree that your contributions will be licensed under the Apache-2.0 License.