Bug 239108 - Add Contributing.md mentioning to how to create PR to WebKit (instead of doing it through GitHub UI)
Summary: Add Contributing.md mentioning to how to create PR to WebKit (instead of doin...
Status: NEW
Alias: None
Product: WebKit
Classification: Unclassified
Component: Tools / Tests (show other bugs)
Version: WebKit Nightly Build
Hardware: Unspecified Unspecified
: P2 Normal
Assignee: Nobody
URL:
Keywords: InRadar
Depends on:
Blocks: 239082
  Show dependency treegraph
 
Reported: 2022-04-11 23:02 PDT by Yusuke Suzuki
Modified: 2022-04-18 23:03 PDT (History)
3 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Yusuke Suzuki 2022-04-11 23:02:26 PDT
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)
Comment 2 Tetsuharu Ohzeki [UTC+9] 2022-04-12 00:27:47 PDT
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.
Comment 3 Yusuke Suzuki 2022-04-12 02:37:56 PDT
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!
Comment 4 Jonathan Bedard 2022-04-14 10:49:29 PDT
(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
Comment 5 Radar WebKit Bug Importer 2022-04-18 23:03:13 PDT
<rdar://problem/91940821>