From 3487f4292050421c99b0d43647183b8d83be2488 Mon Sep 17 00:00:00 2001 From: Jake Bailey <5341706+jakebailey@users.noreply.github.com> Date: Thu, 12 May 2022 14:09:51 -0700 Subject: [PATCH 1/3] Update contributing to mention issue claiming and force pushing --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 741f329d86dc1..53a5d183d31ba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -97,6 +97,10 @@ TypeScript is currently accepting contributions in the form of bug fixes. A bug Features (things that add new or improved functionality to TypeScript) may be accepted, but will need to first be approved (labelled ["help wanted"](https://github.com/Microsoft/TypeScript/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) or in the "Backlog" milestone) by a TypeScript project maintainer in the suggestion issue. Features with language design impact, or that are adequately satisfied with external tools, will not be accepted. +## Claiming issues ("cookie licking") + +Please do not "claim" issues (aka ["cookie lick"](https://devblogs.microsoft.com/oldnewthing/20091201-00/?p=15843)). While it may seem helpful to let people know that you're planning to work on an issue (or to simply ask to work on it), doing so is more likely to cause future contributors to avoid the issue altogether. If you'd like to work on an issue, work on it, and send a PR; if you get stuck or don't have the time, someone else will try again in the future. (If you "claimed" it, that future person may not have considered working on it at all!) + ## Legal You will need to complete a Contributor License Agreement (CLA). Briefly, this agreement testifies that you are granting us permission to use the submitted change according to the terms of the project's license, and that the work being submitted is under appropriate copyright. Upon submitting a pull request, you will automatically be given instructions on how to sign the CLA. @@ -114,6 +118,10 @@ Your pull request should: * Follow the code conventions described in [Coding guidelines](https://github.com/Microsoft/TypeScript/wiki/Coding-guidelines) * To avoid line ending issues, set `autocrlf = input` and `whitespace = cr-at-eol` in your git configuration +## Force-pushing + +Avoid force-pushing your changes, especially when updating your PR based on review feedback. Force-pushed changes are not easily viewable on GitHub, and not at all viewable if a force-push also rebases against main. TypeScript PRs are squash merged, so the specific commits on your PR branch do not matter, only the PR title itself. Don't worry about having a perfect commit history; instead focus on making your changes as easy to review and merge as possible. + ## Contributing `lib.d.ts` fixes There are three relevant locations to be aware of when it comes to TypeScript's library declaration files: From 7006fa67756b6b03cdb8ed5d88dd143e4e645985 Mon Sep 17 00:00:00 2001 From: Jake Bailey <5341706+jakebailey@users.noreply.github.com> Date: Mon, 16 May 2022 15:26:35 -0700 Subject: [PATCH 2/3] Update cookie licking section to draft --- CONTRIBUTING.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 53a5d183d31ba..bac20ed5f6da7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -99,7 +99,11 @@ Features (things that add new or improved functionality to TypeScript) may be ac ## Claiming issues ("cookie licking") -Please do not "claim" issues (aka ["cookie lick"](https://devblogs.microsoft.com/oldnewthing/20091201-00/?p=15843)). While it may seem helpful to let people know that you're planning to work on an issue (or to simply ask to work on it), doing so is more likely to cause future contributors to avoid the issue altogether. If you'd like to work on an issue, work on it, and send a PR; if you get stuck or don't have the time, someone else will try again in the future. (If you "claimed" it, that future person may not have considered working on it at all!) +If you intend to work on an issue, please avoid leaving comments like "I'm going to work on this". There are a few reasons for this. These comments tend to [discourage anyone from working in the area](https://devblogs.microsoft.com/oldnewthing/20091201-00/?p=15843), yet many issues are much more difficult than they first appear, and you might find yourself trying to fix several issues before finding one that can be completed. Many issues have a long trail of people indicating that they're going to try to fix it, but no PR. + +Conversely, you do not need to ask anyone's permission before starting work on an issue marked as "help wanted". It's always fine to try! We ask that you choose issues tagged in the "Backlog" milestone as these are issues that we've identified as needing fixes / implementations. + +The sheer quantity of open issues, combined with their general difficulty, makes it extremely unlikely that you and another contributor are a) working on the same issue and b) both going to find a solution. ## Legal From d28532a30a4382aaf567b1ef07bf093c7d2b6580 Mon Sep 17 00:00:00 2001 From: Jake Bailey <5341706+jakebailey@users.noreply.github.com> Date: Wed, 18 May 2022 15:27:34 -0700 Subject: [PATCH 3/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bac20ed5f6da7..0867225fe1b3d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -97,7 +97,7 @@ TypeScript is currently accepting contributions in the form of bug fixes. A bug Features (things that add new or improved functionality to TypeScript) may be accepted, but will need to first be approved (labelled ["help wanted"](https://github.com/Microsoft/TypeScript/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) or in the "Backlog" milestone) by a TypeScript project maintainer in the suggestion issue. Features with language design impact, or that are adequately satisfied with external tools, will not be accepted. -## Claiming issues ("cookie licking") +## Issue claiming If you intend to work on an issue, please avoid leaving comments like "I'm going to work on this". There are a few reasons for this. These comments tend to [discourage anyone from working in the area](https://devblogs.microsoft.com/oldnewthing/20091201-00/?p=15843), yet many issues are much more difficult than they first appear, and you might find yourself trying to fix several issues before finding one that can be completed. Many issues have a long trail of people indicating that they're going to try to fix it, but no PR.