Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (46 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

63 lines (46 loc) · 1.48 KB
Raw

Contributing to Oathkeeper

Thank you for your interest in contributing to Oathkeeper!

Getting Started

  1. Fork the repository
  2. Clone your fork
  3. Create a feature branch (git checkout -b feature/my-feature)
  4. Make your changes
  5. Test thoroughly
  6. Commit your changes (git commit -m 'Add my feature')
  7. Push to the branch (git push origin feature/my-feature)
  8. Open a Pull Request

Development Requirements

  • Engine (C++): Visual Studio 2026 with C++ Desktop workload, Windows SDK
  • UI (C#): .NET 9.0 SDK
  • Installer: Inno Setup 6

Building

build.bat              # Build everything
build.bat engine       # Build C++ engine only
build.bat ui           # Build C# UI only
build.bat installer    # Build installer only

Or use PowerShell:

.\cook.ps1             # Build everything
.\cook.ps1 verify      # Build + run self-checks

Code Style

C++

  • Use C++20 features where appropriate
  • Use Unicode (UNICODE defined)
  • Follow existing naming conventions (PascalCase for functions, camelCase for locals)

C#

  • Follow standard .NET conventions
  • Use WPF MVVM pattern where possible
  • Keep code-behind minimal

Testing

See TESTING.md for testing guidelines.

Reporting Issues

Use the GitHub issue tracker. Include:

  • Windows version
  • Steps to reproduce
  • Expected vs actual behavior
  • Screenshots if applicable

License

By contributing, you agree that your contributions will be licensed under the GPL v3 License.