Artifactspublic-v0

curl

master
ply4 git calls35 ms289 KiB2 cachedprotocol v2
94 lines4.1 KiBRaw

How to get started helping out in the curl project

We are always in need of more help. If you are new to the project and are looking for ways to contribute and help out, this document aims to give a few good starting points.

You may subscribe to the curl-library mailing list to keep track of the current discussion topics; or if you are registered on GitHub, you can use the Discussions section on the main curl repository.

Scratch your own itch

One of the best ways is to start working on any problems or issues you have 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 do not do that in curl since such issues never linger around long enough. Simple issues get handled fast.

If you are 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 currently tested (correctly)
  • Consider updating or adding documentation
  • One way to get started 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 wanted, as a sign that the bug is acknowledged to exist and that there is nobody known to work on this issue for the moment. Those are bugs that are fine to "grab" and provide a pull request for. The complexity level of these of course varies, so pick one that piques your interest.

Work on known bugs

Some bugs are known and have not yet received attention and work enough to get fixed. We collect such known existing flaws in the KNOWN_BUGS page. Many of them link to the original bug report with some additional details, but some may also have aged a bit and may require some verification that the bug still exists in the same way and that what was said about it in the past is still valid.

Fix autobuild problems

On the autobuilds page we show a collection of test results from the automatic curl build and tests that are performed by volunteers. Fixing compiler warnings and errors shown there is something we value greatly. Also, if you own or run systems or architectures that are not already tested in the autobuilds, we also appreciate more volunteers running builds automatically to help us keep curl portable.

TODO items

Ideas for features and functions that we have considered worthwhile to implement and provide are kept in the TODO file. Some of the ideas are rough. Some are well thought out. Some probably are not really suitable anymore.

Before you invest a lot of time on a TODO item, do bring it up for discussion on the mailing list. For discussion on applicability but also for ideas and brainstorming on specific ways to do the implementation etc.

You decide

You can also come up with a completely new thing you think we should do. Or not do. Or fix. Or add to the project. You then either bring it to the mailing list first to see if people shoot down the idea at once, or you bring a first draft of the idea as a pull request and take the discussion there around the specific implementation. Either way is fine.

CONTRIBUTE

We offer guidelines that are suitable to be familiar with before you decide to contribute to curl. If you are used to open source development, you probably do not find many surprises there.

1<!--
2Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
4SPDX-License-Identifier: curl
5-->
7# How to get started helping out in the curl project
9We are always in need of more help. If you are new to the project and are
10looking for ways to contribute and help out, this document aims to give a few
11good starting points.
13You may subscribe to the [curl-library mailing
14list](https://lists.haxx.se/listinfo/curl-library) to keep track of the
15current discussion topics; or if you are registered on GitHub, you can use the
16[Discussions section](https://github.com/curl/curl/discussions) on the main
17curl repository.
19## Scratch your own itch
21One of the best ways is to start working on any problems or issues you have
22found yourself or perhaps got annoyed at in the past. It can be a spelling
23error in an error text or a weirdly phrased section in a man page. Hunt it
24down and report the bug. Or make your first pull request with a fix for that.
26## Smaller tasks
28Some projects mark small issues as "beginner friendly", "bite-sized" or
29similar. We do not do that in curl since such issues never linger around long
30enough. Simple issues get handled fast.
32If you are looking for a smaller or simpler task in the project to help out
33with as an entry-point into the project, perhaps because you are a newcomer or
34even maybe not a terribly experienced developer, here's our advice:
36- Read through this document to get a grasp on a general approach to use
37- Consider adding a test case for something not currently tested (correctly)
38- Consider updating or adding documentation
39- One way to get started gently in the project, is to participate in an
40 existing issue/PR and help out by reproducing the issue, review the code in
41 the PR etc.
43## Help wanted
45In the issue tracker we occasionally mark bugs with [help
46wanted](https://github.com/curl/curl/labels/help%20wanted), as a sign that the
47bug is acknowledged to exist and that there is nobody known to work on this
48issue for the moment. Those are bugs that are fine to "grab" and provide a
49pull request for. The complexity level of these of course varies, so pick one
50that piques your interest.
52## Work on known bugs
54Some bugs are known and have not yet received attention and work enough to get
55fixed. We collect such known existing flaws in the
56[KNOWN_BUGS](https://curl.se/docs/knownbugs.html) page. Many of them link
57to the original bug report with some additional details, but some may also
58have aged a bit and may require some verification that the bug still exists in
59the same way and that what was said about it in the past is still valid.
61## Fix autobuild problems
63On the [autobuilds page](https://curl.se/dev/builds.html) we show a
64collection of test results from the automatic curl build and tests that are
65performed by volunteers. Fixing compiler warnings and errors shown there is
66something we value greatly. Also, if you own or run systems or architectures
67that are not already tested in the autobuilds, we also appreciate more
68volunteers running builds automatically to help us keep curl portable.
70## TODO items
72Ideas for features and functions that we have considered worthwhile to
73implement and provide are kept in the
74[TODO](https://curl.se/docs/todo.html) file. Some of the ideas are
75rough. Some are well thought out. Some probably are not really suitable
76anymore.
78Before you invest a lot of time on a TODO item, do bring it up for discussion
79on the mailing list. For discussion on applicability but also for ideas and
80brainstorming on specific ways to do the implementation etc.
82## You decide
84You can also come up with a completely new thing you think we should do. Or
85not do. Or fix. Or add to the project. You then either bring it to the mailing
86list first to see if people shoot down the idea at once, or you bring a first
87draft of the idea as a pull request and take the discussion there around the
88specific implementation. Either way is fine.
90## CONTRIBUTE
92We offer [guidelines](https://curl.se/dev/contribute.html) that are suitable
93to be familiar with before you decide to contribute to curl. If you are used
94to open source development, you probably do not find many surprises there.
Diagnostics4 git calls · 35 ms
CallStatusSizeTime035 ms
discover200152 B3 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=152
git.server.agent=gitty/1.0
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch object-format
git.server.fetch=shallow filter sideband-all
git.protocol.version=2
git.pkt.frames=8
git.pkt.data=6
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=152
git.pkt.payload.max=34
ls-refs200149 B3 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=3
git.response.bytes=149
git.response.cache=UPDATING
git.response.duration_ms=3
git.protocol.version=2
git.pkt.frames=3
git.pkt.data=2
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=149
git.pkt.payload.max=78
git.ls_refs.count=2
git.ls_refs.head=refs/heads/master
fetchblob:none · deepen 10200287 KiB · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=30
git.response.bytes=293470
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=blob:none
git.fetch.filter.requested=tree:0
git.fetch.filter.fallback=blob:none
git.fetch.filter.learned=false
git.fetch.wants=31c911efe5652725e930f4d2e60c9060e5f6646d
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=10
git.pkt.data=8
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=293470
git.pkt.payload.max=65516
git.sideband.band1.bytes=293354
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=87
git.pack.bytes=293354
git.pack.ofs_delta=0
git.pack.ref_delta=1
git.pack.chain.max=1
git.pack.trailer=6a646bcda6740bab42e321b51998b52ea15146c0
git.pack.full=86
Open pack map
fetch2002.0 KiB · hit30 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=2074
git.response.cache=HIT
git.response.duration_ms=30
git.fetch.wants=e676dcf08f1bcc31bb100846331d16fa081165e5
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=3
git.pkt.data=2
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=2074
git.pkt.payload.max=2053
git.sideband.band1.bytes=2052
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://5ad2236b39de4c8bd8f6270ea63f3ea9.artifacts.cloudflare.net/git/public-v0/curl.git
Ref
refs/heads/master
Commit
31c911efe5652725e930f4d2e60c9060e5f6646d
cf-ray
a5e1b7763b325b65
Request
80221fbb…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format