summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2020-06-12 12:01:49 +0200
committerDaniel Stenberg <daniel@haxx.se>2020-06-12 15:22:58 +0200
commitbc392074d2f9957e2c3bb9b3c3ec610c284d669e (patch)
tree7fd6be1868d76b00adee07bd929258b4d8a2e6e7
parent95f2732e757d13625dc0ff0343cc7f25052e7f00 (diff)
downloadcurl-bc392074d2f9957e2c3bb9b3c3ec610c284d669e.tar.gz
HELP-US: add a section for "smaller tasks"
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
-rw-r--r--docs/HELP-US.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/HELP-US.md b/docs/HELP-US.md
index aae2b9f59..54744346a 100644
--- a/docs/HELP-US.md
+++ b/docs/HELP-US.md
@@ -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