Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
124 lines (78 loc) · 3.39 KB

CONTRIBUTING.md

File metadata and controls

124 lines (78 loc) · 3.39 KB

Contributions Welcome

Thanks for your interest in contributing to @lopatnov/express-reverse-proxy! Contributing to open source can be a rewarding way to learn, share knowledge, and build experience. We are glad you are here.

Table of Contents

  1. Types of Contributions
  2. Ground Rules & Expectations
  3. How to Contribute

Types of Contributions

You do not have to contribute code to make a difference. Here are some ways you can help:

Developers can:

  • Take a look at the open issues and find one to work on.
  • Locate and fix bugs in server.js or the configuration handling logic.
  • Implement new features or improve existing ones.
  • Improve tooling, scripts, or the Docker/PM2 setup.

Writers can:

  • Fix or improve the project documentation.
  • Add more configuration examples or recipes to the README.
  • Improve inline comments in server.js.

Testers can:

  • Report reproducible bugs with a minimal server-config.json example.
  • Verify that existing issues are still present or have been resolved.

Supporters can:

  • Answer questions in Discussions.
  • Help triage open issues — identify duplicates, ask clarifying questions.

Ground Rules & Expectations

Please read the Code of Conduct before contributing. By participating in this project, you agree to uphold its standards.

How to Contribute

If you have an idea, first search open issues and pull requests to see if it has already been discussed.

If it has not:

  • Minor change (typo, doc fix): Open a pull request directly.
  • Major change (new feature, API change): Open an issue first to discuss the approach.

Step-by-step workflow

  1. Fork the repository by clicking Fork on GitHub.

  2. Clone your fork locally:

    git clone https://github.com/<YOUR-USERNAME>/express-reverse-proxy

  3. Add the upstream remote so you can sync changes:

    git remote add upstream https://github.com/lopatnov/express-reverse-proxy

  4. Sync your local master branch with upstream:

    git checkout master
git pull upstream master && git push origin master

  5. Create a new branch from master:

    git checkout -b <your-branch-name>

  6. Make your changes to the code or documentation.

  7. Test your changes:

    # Start the server and verify it works
node server.js --config server-config.json

# Run the full demo (backends + proxy)
npm run demo

# Check for lint errors
npm run lint

  8. Commit your changes. Use a present-tense message describing what the commit does when applied:

    git commit -m "Add support for multiple proxy targets"

  9. Push your branch to your fork:

    git push -u origin <your-branch-name>

  10. Open a pull request on GitHub from your fork's branch to lopatnov/express-reverse-proxy:master.

  11. Respond to any review comments and push follow-up commits if needed.

  12. Once merged, you can delete your branch and sync your fork.

Happy contributing!