meta: add CONTRIBUTING.md
#5680
Conversation
ErichDonGubler
force-pushed
the
contributing
branch
2 times, most recently
from
048ebff
to
effb960
Compare
|
Could we decouple this from #5679? |
|
Alternatively, lets use this PR for both - I don't think they really need to be separate. |
| - [GitHub discussions]: TODO: not sure when to use this over Matrix and issues. | ||
| TBH. |
There was a problem hiding this comment.
issue: This does not seem to receive significant attention from current maintainership. If we officially mention this here, we should say that, at best, GitHub discussions are a community experiment.
There was a problem hiding this comment.
Let's leave it out for now. We can always add it later if we start properly monitoring/using it.
| 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 |
There was a problem hiding this comment.
"Almost all modifications of this repository happen via pull requests including for maintainers of the project."
I'd remove the "almost" but someone will find some edge case and prove me wrong. I don't think that we need to formalize what a pull request is beyond beyond that.
|
|
||
| ### "What can I work on?" | ||
|
|
||
| TODO |
There was a problem hiding this comment.
| TODO | |
| The [help wanted] label is a good place to find a topic for anyone looking to contribute. In general it is preferable to avoid starting with code refactorings. As satisfying as they can sometimes be, refactorings tend to be lower impact, higher risk and require more effort from the reviewer than most contributions. | |
| [help wanted]: https://github.com/gfx-rs/wgpu/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 |
|
|
||
| ### 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 |
ErichDonGubler
force-pushed
the
contributing
branch
from
effb960
to
d8b6324
Compare
| - [GitHub discussions]: TODO: not sure when to use this over Matrix and issues. | ||
| TBH. |
There was a problem hiding this comment.
Let's leave it out for now. We can always add it later if we start properly monitoring/using it.
| - …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 |
There was a problem hiding this comment.
Should probably add:
- Asking questions.
What's with the leading ... here? Looks a bit unusual to me.
| 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 |
There was a problem hiding this comment.
"These could be bug reports or decisions to make with [...]"
Bug reports are common and important enough that it should explicitly be spelled out in my opinion. "Items of works resolved by pull requests" is too abstract I think.
|
|
||
| - [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 |
There was a problem hiding this comment.
What's a formal outcome? Maybe a bit too abstract for a portion of non-native English speakers like myself.
| 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 |
There was a problem hiding this comment.
"Almost all modifications of this repository happen via pull requests including for maintainers of the project."
I'd remove the "almost" but someone will find some edge case and prove me wrong. I don't think that we need to formalize what a pull request is beyond beyond that.
|
|
||
| ### "What can I work on?" | ||
|
|
||
| TODO |
There was a problem hiding this comment.
| TODO | |
| The [help wanted] label is a good place to find a topic for anyone looking to contribute. In general it is preferable to avoid starting with code refactorings. As satisfying as they can sometimes be, refactorings tend to be lower impact, higher risk and require more effort from the reviewer than most contributions. | |
| [help wanted]: https://github.com/gfx-rs/wgpu/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 |
Hard dependency on #5679.