Thank you for your interest in contributing to the Payroll Engine! This document describes how you can get involved.
🚧 The Payroll Engine is currently in pre-release (
0.y.z). Breaking changes are possible at any time until version 1.0. Please keep this in mind before starting any larger contribution.
Community contributions are currently welcome in the following areas:
| Area | Description |
|---|---|
| Docker | Improvements to the Docker Compose stack |
| CI/CD | CI/CD integrations across the repositories |
| Linux Setup | Running and setting up the engine on Linux |
| Web App Localization | Translations for the web application |
| Alternative Databases | Persistence layer implementations for databases other than SQL Server (see SQL Server implementation as reference) |
If you are interested in working on one of these areas, please contact us before starting, so we can coordinate and avoid duplicate effort.
Use GitHub Issues to report bugs or unexpected behavior. Please include:
- A clear description of the problem
- Steps to reproduce
- Expected vs. actual behavior
- Environment details (.NET version, OS, Docker version if applicable)
For security vulnerabilities, do not open a public issue — see SECURITY.md for the responsible disclosure process.
Use GitHub Discussions for feature suggestions, questions, and general feedback. This is the preferred channel for open-ended topics that are not yet actionable as issues.
Before opening a pull request, please:
- Open an issue or discussion to align on the approach
- Ensure your changes are consistent with the existing code style (.NET / C#)
- Add or update tests where applicable
- Keep commits focused and well-described
All contributions must be compatible with the MIT License.
- Docker — required to run the full stack
- .NET 10.0 SDK — for backend and client development
- See Container Setup for getting the stack running locally
The repositories use .editorconfig and Roslyn Analyzers to enforce a
consistent code style. All analyzer warnings are treated as errors —
your build must be warning-free before opening a pull request.
Recommended tooling:
- JetBrains Rider — free for non-commercial use, includes full ReSharper analysis inline
- ReSharper — Visual Studio extension; JetBrains offers free licenses for open-source contributors
Both tools surface the same analyzer violations that the CI build enforces. Using one of them locally saves review cycles.
This project follows the Contributor Covenant Code of Conduct. By participating, you are expected to uphold these standards.
- 📧 Email: info@payrollengine.org
- 💬 Discussions: github.com/Payroll-Engine/PayrollEngine/discussions
- 💖 Sponsorship: github.com/sponsors/Payroll-Engine