Skip to content

Update CONTRIBUTING.md to mention issue claiming and force pushing #49090

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 19, 2022

Conversation

jakebailey
Copy link
Member

Let me know if you want these worded differently, or that link to the old Raymond blog removed.

@typescript-bot typescript-bot added Author: Team For Uncommitted Bug PR for untriaged, rejected, closed or missing bug labels May 12, 2022
@jakebailey jakebailey changed the title Update contributing to mention issue claiming and force pushing Update CONTRIBUTING.md to mention issue claiming and force pushing May 12, 2022
@RyanCavanaugh
Copy link
Member

Please do not "claim" issues (aka "cookie lick"). 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!)

There are two symmetric behaviors I want to discourage - cookie licking, and asking if it's OK to eat the cookie.

Draft

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, 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. 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.

@jakebailey
Copy link
Member Author

I think that reads well to me.

@DanielRosenwasser
Copy link
Member

- Conversely, you do not need to ask anyone's permission before starting work on an issue
+ Conversely, you do not need to ask anyone's permission before starting work on an issue marked as "help wanted"

@jakebailey
Copy link
Member Author

Updated to match the draft + Daniel's change.

@jakebailey
Copy link
Member Author

@RyanCavanaugh Any other changes you're looking for here?

@RyanCavanaugh
Copy link
Member

shipit.gif

@jakebailey jakebailey merged commit f6a1713 into microsoft:main May 19, 2022
@jakebailey jakebailey deleted the contributing-1 branch May 19, 2022 20:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Author: Team For Uncommitted Bug PR for untriaged, rejected, closed or missing bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants