Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 1.87 KB

File metadata and controls

61 lines (43 loc) · 1.87 KB

Contributing to http-proxy

Thank you for considering contributing to http-proxy! Your support helps improve the project for everyone.

📌 Code of Conduct

Please adhere to our Code of Conduct to ensure a welcoming environment for all contributors.

🛠️ How to Contribute

Reporting Bugs

  • Search Existing Issues: Before reporting, check if the issue already exists.
  • Provide Details: Include steps to reproduce, expected behavior, and screenshots if applicable.
  • Environment Info: Share details about your setup (OS, Node.js version, etc.).

Suggesting Enhancements

  • Describe Clearly: Outline the enhancement and its benefits.
  • Scope: Ensure it aligns with the project's goals.
  • Alternatives: Mention any alternative solutions you've considered.

Submitting Pull Requests

  • Fork the Repository: Create your own fork and work on a new branch.
  • Follow Coding Standards: Maintain consistency with the existing codebase.
  • Test Your Changes: Ensure all tests pass and add new tests if necessary.
  • Update Documentation: Reflect any changes in the documentation.
  • Commit Messages: Write clear and descriptive commit messages.
  • Pull Request Description: Detail what changes you've made and why.

🧪 Development Setup

  1. Clone the Repository:
    git clone https://github.com/HCDevWorks/http-proxy.git
  2. Navigate to the Project Directory:
    cd http-proxy
  3. Install Dependencies:
    pnpm install
  4. Run the Project:
    pnpm dev

📝 Style Guide

📬 Getting Help

If you have questions or need assistance, feel free to open an issue or contact the maintainers directly.


Happy coding! 🚀