Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (33 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 1.47 KB

Contributing to Webhook Debugger & Logger

Thank you for your interest in contributing to the Webhook Debugger & Logger Apify Actor! We welcome contributions from the community.

How to Contribute

Reporting Bugs

If you find a bug, please create a new issue in the GitHub repository. Be sure to include:

  • A clear description of the issue
  • Steps to reproduce
  • Expected vs. actual behavior
  • Any relevant error logs or screenshots

Feature Requests

Have an idea for a new feature? We'd love to hear it! Open an issue describing:

  • The problem you want to solve
  • Your proposed solution
  • Any alternatives you've considered

Pull Requests

  1. Fork the repository and create a new branch for your feature or fix.
  2. Follow code style guidelines:
    • Use meaningful variable/function names.
    • Write self-documenting code with comments for complex logic.
    • Run npm run lint and npm run typecheck to ensure no errors.
  3. Write tests:
    • Add unit tests for new logic.
    • Run npm test to ensure all tests pass.
    • See tests/README.md for detailed guidelines on test organization and helpers.
  4. Submit a Pull Request:
    • Provide a clear title and description.
    • Reference any related issues.

Development Setup

  1. Clone the repository.
  2. Run npm install to install dependencies.
  3. Run npm test to verify the setup.

License

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