CONTRIBUTING.md
Rama main · réplica de lectura del repositorio original.
# Contributing to ProxMate
Thank you for your interest in contributing to ProxMate. We welcome contributions from anyone, whether you are fixing bugs, improving documentation, suggesting features, or helping others in our community discussions.
## How to Get Involved
There are many ways to contribute to ProxMate:
- **Participate in Discussions**: Help answer questions, discuss ideas, or showcase your setup in our Discussions section.
- **Report Bugs**: If you find an issue, search our existing issues to see if it has been reported, or open a new issue.
- **Suggest Features**: Share your ideas for new features or improvements.
- **Submit Pull Requests**: Implement code fixes, build new features, or improve our documentation. Code contributions are accepted to the **Community Edition only** and require agreeing to our [Contributor License Agreement](./CLA.md) — see *Licensing of Contributions* below.
## Community Code of Conduct
To ensure a welcoming, inclusive, and safe environment for everyone, we ask that all participants adhere to basic standards of respect and collaboration:
- Be respectful, constructive, and empathetic to others.
- Focus on what is best for the community.
- Gracefully accept constructive criticism.
## Getting Started with Development
To set up your local development environment, please follow the detailed steps in the [README](README.md) file.
The repository structure is organized as follows:
- `frontend/`: Next.js dashboard and setup wizard.
- `backend/`: Express API, Proxmox proxy, and WebSocket relay.
- `docs/`: Guides and reference documentation.
If you have any questions or need help setting up, feel free to ask in the Q&A section of our Discussions.
## Licensing of Contributions
ProxMate is **open core** (see [LICENSING.md](./LICENSING.md)):
- The **Community Edition** in this repository is free and open source under the
**AGPLv3**. All code contributions are to the Community Edition.
- The **EDU Edition** is a separate commercial product and is **not** open to
outside contributions.
To keep the project able to offer both editions, code contributions must be made
under our **Contributor License Agreement** ([CLA.md](./CLA.md)). The CLA lets you
keep copyright of your own work while granting the maintainer the rights needed to
ship it in both editions.
**Current status:** ProxMate is maintained by a single author and is **not yet
actively accepting external code contributions.** The most helpful things you can
do right now are join the Discussions, report bugs, and suggest features. When
code contributions open up, the CLA above will apply.