Contributing

October 2023: The information below is out of date. For now, please refer to the contributing.md document in the repository for more current guidelines.

OpenTK is a large project, comprising roughly 1 million lines of code and documentation. Help us improve OpenTK by contributing bug reports, code and documentation.

Contributing code

1. Install git and a C# IDE (see requirements section below)
2. Fork the develop branch of https://github.com/opentk/opentk
3. Commit your changes in small, incremental steps with clear descriptions
4. When ready, issue a Pull Request (PR) against the develop branch of https://github.com/opentk/opentk

Best practices

• Do make sure that any public APIs you add follow the Library Design Guidelines. Consider filing a bug report to discuss your intended changes first.
• Do document all public APIs that you add.
• Do use Visual Studio formatting for C# code: 4 space indentation, braces on newlines.
• Do not modify or remove public APIs in a way that could break existing applications.
• Do not insert tab characters or change indentation of existing code. This makes PRs more difficult to review.