From 5aaf5aac0b0f33f82262bad79e03b2871c0d47dc Mon Sep 17 00:00:00 2001 From: Stas Bekman Date: Wed, 21 Apr 2021 10:10:11 -0700 Subject: [PATCH] [contributing doc] explain/link to good first issue (#11346) * explain/link to good first issue * Apply suggestions from code review Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com> Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com> --- CONTRIBUTING.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9978e90b34..f4ebe3a34f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,6 +36,13 @@ There are 4 ways you can contribute to transformers: * Contributing to the examples or to the documentation; * Submitting issues related to bugs or desired new features. +In particular there is a special [Good First +Issue](https://github.com/huggingface/transformers/contribute) listing. Tt will give you a list of +open Issues that are open to anybody to work on. Just comment in the issue that you'd like to work +on it. In that same listing you will also find some Issues with `Good Second Issue` label. These are +typically slightly more complicated than the Issues with just `Good First Issue` label. But if you +feel you know what you're doing, go for it. + *All are equally valuable to the community.* ## Submitting a new issue or feature request @@ -46,7 +53,7 @@ feedback. ### Did you find a bug? -The transformers are robust and reliable thanks to the users who notify us of +The 🤗 Transformers library is robust and reliable thanks to the users who notify us of the problems they encounter. So thank you for reporting an issue. First, we would really appreciate it if you could **make sure the bug was not @@ -343,7 +350,7 @@ You can now use `make` from any terminal (Powershell, cmd.exe, etc) 🎉 ### Syncing forked master with upstream (HuggingFace) master -To avoid pinging the upstream repository which adds reference notes to each upstream PR and sends unnessary notifications to the developers involved in these PRs, +To avoid pinging the upstream repository which adds reference notes to each upstream PR and sends unnessary notifications to the developers involved in these PRs, when syncing the master branch of a forked repository, please, follow these steps: 1. When possible, avoid syncing with the upstream using a branch and PR on the forked repository. Instead merge directly into the forked master. 2. If a PR is absolutely necessary, use the following steps after checking out your branch: