-
Notifications
You must be signed in to change notification settings - Fork 629
Contributing
Jon McGuire edited this page Oct 10, 2023
·
16 revisions
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.
- Install git and a C# IDE (see requirements section below)
- Fork the develop branch of https://github.com/opentk/opentk
- Commit your changes in small, incremental steps with clear descriptions
- When ready, issue a Pull Request (PR) against the develop branch of https://github.com/opentk/opentk
- 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.