Skip to content

Commit

Permalink
meta: add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ErichDonGubler committed May 8, 2024
1 parent ece8afa commit 048ebff
Showing 1 changed file with 57 additions and 0 deletions.
57 changes: 57 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
This document is a guide for contributions to the WGPU project.

## Welcome!

First of all, welcome to the WGPU community! 👋 We're glad you want to
contribute. If you are unfamiliar with the WGPU community as an organization, we
recommend you read [`GOVERNANCE.md`] for an overview of how it works.

[`GOVERNANCE.md`](./GOVERNANCE.md)

## Talking to other humans in the WGPU project

The WGPU project has multiple ways to engage:

- [GitHub discussions]: TODO: not sure when to use this over Matrix and issues.
TBH.
- The Matrix channel [`wgpu:matrix.org`](https://matrix.to/#/#wgpu:matrix.org)
is dedicated to informal chat about contributions the project. It is
particularly useful for:
- …saying hello, and introducing yourself.
- …validating contributions (i.e., determining if they'll be accepted,
ensuring your approach is correct, making sure you aren't wasting effort,
etc.)
- …setting expectations for contributions

Notification in Matrix can sometimes be unreliable. Feel free to explicitly tag
people from whom you would like attention (but don't abuse it!), and follow-up
after a day or so if you do not get a response to your messages.

- [GitHub issues] are for action items that the community needs to prioritize.
These could be items of work resolved by pull requests, decisions to make with
a formal outcome, or collections of issues needed for a specific feature or
use case (AKA `[meta]` issues).
- [GitHub pull requests]: TODO

[GitHub discussions]: https://github.com/gfx-rs/wgpu/discussions
[GitHub issues]: https://github.com/gfx-rs/wgpu/issues
[GitHub pull requests]: https://github.com/gfx-rs/wgpu/pulls

## Contributing to WGPU

Community response to contributions are, in general, prioritized based on their
relevance to WGPU's mission and decision-making groups' interest (see
[`GOVERNANCE.md`]).

### "What can I work on?"

TODO

### What to expect when you file an issue

TODO

### What to expect when you submit a PR

TODO: It is strongly recommended that you validate your contributions before you make
significant efforts…

0 comments on commit 048ebff

Please sign in to comment.