Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (43 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

59 lines (43 loc) · 1.4 KB

Contributing to ngx-performance-diagnostics

First off, thanks for taking the time to contribute! 🎉

How to Contribute

Reporting Bugs

  1. Check if the bug has already been reported in Issues
  2. If not, create a new issue with:
    • Clear title and description
    • Steps to reproduce
    • Expected vs actual behavior
    • Angular version
    • Browser version

Suggesting Features

  1. Check Issues for similar suggestions
  2. Create a new issue with:
    • Clear use case
    • Why this feature would be useful
    • Proposed API (if applicable)

Pull Requests

  1. Fork the repo
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Test your changes
  5. Commit (git commit -m 'Add amazing feature')
  6. Push (git push origin feature/amazing-feature)
  7. Open a Pull Request

Development Setup

git clone https://github.com/yourusername/ngx-performance-diagnostics.git
cd ngx-performance-diagnostics
npm install
npm run build

Code Style

  • Follow the existing code style
  • Use TypeScript strict mode
  • Add JSDoc comments for public APIs
  • Keep functions small and focused

Testing

npm test

License

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