43 lines
2.3 KiB
Markdown
43 lines
2.3 KiB
Markdown
|
# Winit Contributing Guidelines
|
||
|
|
|
||
|
|
## Scope
|
||
|
|
[See `FEATURES.md`](./FEATURES.md). When requesting or implementing a new Winit feature, you should
|
||
|
|
consider whether or not it's directly related to window creation or input handling. If it isn't, it
|
||
|
|
may be worth creating a separate crate that extends Winit's API to add that functionality.
|
||
|
|
|
||
|
|
|
||
|
|
## Reporting an issue
|
||
|
|
|
||
|
|
When reporting an issue, in order to help the maintainers understand what the problem is, please make
|
||
|
|
your description of the issue as detailed as possible:
|
||
|
|
|
||
|
|
- if it is a bug, please provide clear explanation of what happens, what should happen, and how to
|
||
|
|
reproduce the issue, ideally by providing a minimal program exhibiting the problem
|
||
|
|
- if it is a feature request, please provide a clear argumentation about why you believe this feature
|
||
|
|
should be supported by winit
|
||
|
|
|
||
|
|
## Making a pull request
|
||
|
|
|
||
|
|
When making a code contribution to winit, before opening your pull request, please make sure that:
|
||
|
|
|
||
|
|
- you tested your modifications on all the platforms impacted, or if not possible detail which platforms
|
||
|
|
were not tested, and what should be tested, so that a maintainer or another contributor can test them
|
||
|
|
- you updated any relevant documentation in winit
|
||
|
|
- you left comments in your code explaining any part that is not straightforward, so that the
|
||
|
|
maintainers and future contributors don't have to try to guess what your code is supposed to do
|
||
|
|
- your PR adds an entry to the changelog file if the introduced change is relevant to winit users
|
||
|
|
- if your PR affects the platform compatibility of one or more features or adds another feature, the
|
||
|
|
relevant sections in [`FEATURES.md`](https://github.com/rust-windowing/winit/blob/master/FEATURES.md#features)
|
||
|
|
should be updated.
|
||
|
|
|
||
|
|
Once your PR is open, you can ask for review by a maintainer of your platform. Winit's merging policy
|
||
|
|
is that a PR must be approved by at least two maintainers of winit before being merged, including
|
||
|
|
at least a maintainer of the platform (a maintainer making a PR themselves counts as approving it).
|
||
|
|
|
||
|
|
## Maintainers & Testers
|
||
|
|
|
||
|
|
The current [list of testers and contributors](https://github.com/rust-windowing/winit/wiki/Testers-and-Contributors)
|
||
|
|
can be found on the Wiki.
|
||
|
|
|
||
|
|
If you are interested in contributing or testing on a platform, please add yourself to that table!
|