Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (37 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

59 lines (37 loc) · 1.9 KB
Raw

Contributing to Wiredoor

We welcome contributions of all kinds to the Wiredoor project, whether it's bug reports, feature requests, code, documentation, or community engagement.

🧩 What is Wiredoor?

Wiredoor is an open-source platform that allows you to securely expose private services through an encrypted reverse VPN tunnel using WireGuard and a lightweight proxy system powered by NGinx. It's self-hostable, minimal, and privacy-focused.

📌 How to Contribute

Prerequisites

1. Fork & Clone

git clone https://github.com/wirdoor/wiredoor.git
cd wiredoor

Open project with Dev Container and Install any dependencies, depending on the component (./, frontend/).

2. Open an Issue First

Before submitting a Pull Request, please open an issue to discuss:

  • Bugs
  • Features
  • Documentation updates

That helps us maintain project direction and avoid duplicate work.

3. Style Guidelines

  • Server: Node.js/TypeScript (follow project's ESLint/Prettier rules)
  • Frontend: Vue.js/TypeScript (follow project's ESLint/Prettier rules)
  • Docs: Use MDX following Nextra Guidelines
  • Keep PRs small and focused

4. Submitting a Pull Request

  1. Fork the repo
  2. Create a feature branch
  3. Write your changes
  4. Commit with clear messages using conventional commits
  5. Open a PR against the development branch

5. Code of conduct

Please be kind and respectfull. All contributions are subject to our Code of Conduct

🙏 Thank You!

Your input makes Wiredoor better for everyone. Whether you're reporting a typo or building a new feature, we appreciate your effort!