Bug 239108
| Summary: | Add Contributing.md mentioning to how to create PR to WebKit (instead of doing it through GitHub UI) | ||
|---|---|---|---|
| Product: | WebKit | Reporter: | Yusuke Suzuki <ysuzuki> |
| Component: | Tools / Tests | Assignee: | Nobody <webkit-unassigned> |
| Status: | NEW | ||
| Severity: | Normal | CC: | jbedard, tetsuharu.ohzeki, webkit-bug-importer |
| Priority: | P2 | Keywords: | InRadar |
| Version: | WebKit Nightly Build | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| See Also: |
https://bugs.webkit.org/show_bug.cgi?id=239082 https://bugs.webkit.org/show_bug.cgi?id=239347 |
||
| Bug Depends on: | |||
| Bug Blocks: | 239082 | ||
Yusuke Suzuki
Contributing.md can be shown when opening PR via GitHub UI.
While we are using tools (git-webkit) to create PR with specific format, it is not easily obvious to new contributors.
Let's add Contributing.md mentioning to
1. The way to create PR through git-webkit (and introducing https://github.com/WebKit/WebKit/wiki/Contributing link)
2. Not creating a PR though GitHub UI in a normal way (just creating a branch and PR)
| Attachments | ||
|---|---|---|
| Add attachment proposed patch, testcase, etc. |
Yusuke Suzuki
Some examples.
LLVM https://github.com/llvm/llvm-project/blob/main/CONTRIBUTING.md
FoundationDB https://github.com/apple/foundationdb/blob/main/CONTRIBUTING.md
Swift https://github.com/apple/swift/blob/main/CONTRIBUTING.md
Go https://github.com/golang/go/blob/master/CONTRIBUTING.md
Tetsuharu Ohzeki [UTC+9]
Additionally, I think it’s better to add a PR template like https://github.com/llvm/llvm-project/blob/main/.github/PULL_REQUEST_TEMPLATE.md
I guess strongly some people will not read CONTRIBUTING.md because it’s shown as a link. But PR template fills the form to create PR.
Yusuke Suzuki
PULL_REQUEST_TEMPLATE sounds good.
We should offer the best way for contributors to access to the expected procedure so that we will not waste contributors' time and their patches!
Jonathan Bedard
(In reply to Yusuke Suzuki from comment #3)
> PULL_REQUEST_TEMPLATE sounds good.
> We should offer the best way for contributors to access to the expected
> procedure so that we will not waste contributors' time and their patches!
Adding the PR template in https://bugs.webkit.org/show_bug.cgi?id=239347
Radar WebKit Bug Importer
<rdar://problem/91940821>