]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
HELP-US: add a section for "smaller tasks"
authorDaniel Stenberg <daniel@haxx.se>
Fri, 12 Jun 2020 10:01:49 +0000 (12:01 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Fri, 12 Jun 2020 13:22:58 +0000 (15:22 +0200)
The point of this section is to meet the CII Best Practices gold level
critera:

 "The project MUST clearly identify small tasks that can be performed by
  new or casual contributors"

Closes #5560

docs/HELP-US.md

index aae2b9f59908038ea7ee8162e90768b091c363f4..54744346a19475fd01ae75d409220498f76c651f 100644 (file)
@@ -15,6 +15,23 @@ found yourself or perhaps got annoyed at in the past. It can be a spelling
 error in an error text or a weirdly phrased section in a man page. Hunt it
 down and report the bug. Or make your first pull request with a fix for that.
 
+## Smaller tasks
+
+Some projects mark small issues as "beginner friendly", "bite-sized" or
+similar. We don't do that in curl since such issues never linger around long
+enough. Simple issues get handled very fast.
+
+If you're looking for a smaller or simpler task in the project to help out
+with as an entry-point into the project, perhaps because you are a newcomer or
+even maybe not a terribly experienced developer, here's our advice:
+
+ - Read through this document to get a grasp on a general approach to use
+ - Consider adding a test case for something not currentled tested (correctly)
+ - Consider updating or adding documentation
+ - One way to get your feet wet gently in the project, is to participate in an
+   existing issue/PR and help out by reproducing the issue, review the code in
+   the PR etc.
+
 ## Help wanted
 
 In the issue tracker we occasionally mark bugs with [help