curl/curl
1
1
Fork 0
mirror of https://github.com/curl/curl.git synced 2025-09-20 19:12:40 +03:00
Code Issues Packages Projects Releases Wiki Activity

CONTRIBUTE: changed to markdown

Browse Source
This commit is contained in:
Daniel Stenberg 2016-08-09 11:39:58 +02:00
parent 1af5958978
commit 08fd82f370
1 changed files with 180 additions and 204 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

350
docs/CONTRIBUTE
View File

@ -1,271 +1,247 @@
_ _ ____ _ # Contributing to the curl project
___| | | | _ \| |
/ __| | | | |_) | |
| (__| |_| | _ <| |___
\___|\___/|_| \_\_____|
When Contributing Source Code This document is intended to offer guidelines on how to best contribute to the
curl project. This concerns new features as well as corrections to existing
flaws or bugs.
This document is intended to offer guidelines that can be useful to keep in ## Learning cURL
mind when you decide to contribute to the project. This concerns new features
as well as corrections to existing flaws or bugs.
1. Learning cURL ### Join the Community
1.1 Join the Community
1.2 License
1.3 What To Read
2. Write a good patch Skip over to [https://curl.haxx.se/mail/](https://curl.haxx.se/mail/) and join
2.1 Follow code style the appropriate mailing list(s). Read up on details before you post
2.2 Non-clobbering All Over questions. Read this file before you start sending patches! We prefer
2.3 Write Separate Patches questions sent to and discussions being held on the mailing list(s), not sent
2.4 Patch Against Recent Sources to individuals.
2.5 Document
2.6 Test Cases
3. Sharing Your Changes Before posting to one of the curl mailing lists, please read up on the
3.1 How to get your changes into the main sources [mailing list etiquette](https://curl.haxx.se/mail/etiquette.html).
3.2 About pull requests
3.3 Making quality patches
3.5 Write good commit messages
3.6 Write Access to git Repository
3.7 How To Make a Patch with git
3.8 How To Make a Patch without git
============================================================================== We also hang out on IRC in #curl on irc.freenode.net
1. Learning cURL If you're at all interested in the code side of things, consider clicking
'watch' on the [curl repo on github](https://github.com/curl/curl) to get
notified on pull requests and new issues posted there.
1.1 Join the Community ### License and copyright
Skip over to https://curl.haxx.se/mail/ and join the appropriate mailing When contributing with code, you agree to put your changes and new code under
list(s). Read up on details before you post questions. Read this file before the same license curl and libcurl is already using unless stated and agreed
you start sending patches! We prefer patches and discussions being held on otherwise.
the mailing list(s), not sent to individuals.
Before posting to one of the curl mailing lists, please read up on the mailing If you add a larger piece of code, you can opt to make that file or set of
list etiquette: https://curl.haxx.se/mail/etiquette.html files to use a different license as long as they don't enforce any changes to
the rest of the package and they make sense. Such "separate parts" can not be
GPL licensed (as we don't want copyleft to affect users of libcurl) but they
must use "GPL compatible" licenses (as we want to allow users to use libcurl
properly in GPL licensed environments).
We also hang out on IRC in #curl on irc.freenode.net When changing existing source code, you do not alter the copyright of the
original file(s). The copyright will still be owned by the original creator(s)
or those who have been assigned copyright by the original author(s).
If you're at all interested in the code side of things, consider clicking By submitting a patch to the curl project, you are assumed to have the right
'watch' on the curl repo at github to get notified on pull requests and new to the code and to be allowed by your employer or whatever to hand over that
issues posted there. patch/code to us. We will credit you for your changes as far as possible, to
give credit but also to keep a trace back to who made what changes. Please
always provide us with your full real name when contributing!
1.2. License ### What To Read
When contributing with code, you agree to put your changes and new code under Source code, the man pages, the [INTERNALS
the same license curl and libcurl is already using unless stated and agreed document](https://curl.haxx.se/dev/internals.html),
otherwise. [TODO](https://curl.haxx.se/docs/todo.html),
[KNOWN_BUGS](https://curl.haxx.se/docs/knownbugs.html) and the [most recent
changes](https://curl.haxx.se/dev/sourceactivity.html) in git. Just lurking on
the [curl-library mailing
list](https://curl.haxx.se/mail/list.cgi?list=curl-library) will give you a
lot of insights on what's going on right now. Asking there is a good idea too.
If you add a larger piece of code, you can opt to make that file or set of ## Write a good patch
files to use a different license as long as they don't enforce any changes to
the rest of the package and they make sense. Such "separate parts" can not be
GPL licensed (as we don't want copyleft to affect users of libcurl) but they
must use "GPL compatible" licenses (as we want to allow users to use libcurl
properly in GPL licensed environments).
When changing existing source code, you do not alter the copyright of the ### Follow code style
original file(s). The copyright will still be owned by the original
creator(s) or those who have been assigned copyright by the original
author(s).
By submitting a patch to the curl project, you are assumed to have the right When writing C code, follow the
to the code and to be allowed by your employer or whatever to hand over that [CODE_STYLE](https://curl.haxx.se/dev/code-style.html) already established in
patch/code to us. We will credit you for your changes as far as possible, to the project. Consistent style makes code easier to read and mistakes less
give credit but also to keep a trace back to who made what changes. Please likely to happen. Run `make checksrc` before you submit anything, to make sure
always provide us with your full real name when contributing! you follow the basic style. That script doesn't verify everything, but if it
complains you know you have work to do.
1.3 What To Read ### Non-clobbering All Over
Source code, the man pages, the INTERNALS document, TODO, KNOWN_BUGS and the When you write new functionality or fix bugs, it is important that you don't
most recent changes in the git log. Just lurking on the curl-library mailing fiddle all over the source files and functions. Remember that it is likely
list is gonna give you a lot of insights on what's going on right now. Asking that other people have done changes in the same source files as you have and
there is a good idea too. possibly even in the same functions. If you bring completely new
functionality, try writing it in a new source file. If you fix bugs, try to
fix one bug at a time and send them as separate patches.
2. Write a good patch ### Write Separate Changes
2.1 Follow code style It is annoying when you get a huge patch from someone that is said to fix 511
odd problems, but discussions and opinions don't agree with 510 of them - or
509 of them were already fixed in a different way. Then the person merging
this change needs to extract the single interesting patch from somewhere
within the huge pile of source, and that gives a lot of extra work.
When writing C code, follow the CODE_STYLE already established in the Preferably, each fix that correct a problem should be in its own patch/commit
project. Consistent style makes code easier to read and mistakes less likely with its own description/commit message stating exactly what they correct so
to happen. Run 'make checksrc' before you submit anything, to make sure you that all changes can be selectively applied by the maintainer or other
follow the basic style. That script doesn't verify everything, but if it interested parties.
complains you know you have work to do.
2.2 Non-clobbering All Over Also, separate changes enable bisecting much better when we track problems
and regression in the future.
When you write new functionality or fix bugs, it is important that you don't ### Patch Against Recent Sources
fiddle all over the source files and functions. Remember that it is likely
that other people have done changes in the same source files as you have and
possibly even in the same functions. If you bring completely new
functionality, try writing it in a new source file. If you fix bugs, try to
fix one bug at a time and send them as separate patches.
2.3 Write Separate Patches Please try to get the latest available sources to make your patches against.
It makes the lives of the developers so much easier. The very best is if you
get the most up-to-date sources from the git repository, but the latest
release archive is quite OK as well!
It is annoying when you get a huge patch from someone that is said to fix 511 ### Documentation
odd problems, but discussions and opinions don't agree with 510 of them - or
509 of them were already fixed in a different way. Then the patcher needs to
extract the single interesting patch from somewhere within the huge pile of
source, and that gives a lot of extra work. Preferably, all fixes that
correct different problems should be in their own patch with an attached
description exactly what they correct so that all patches can be selectively
applied by the maintainer or other interested parties.
Also, separate patches enable bisecting much better when we track problems in Writing docs is dead boring and one of the big problems with many open source
the future. projects. Someone's gotta do it. It makes it a lot easier if you submit a
small description of your fix or your new features with every contribution so
that it can be swiftly added to the package documentation.
2.4 Patch Against Recent Sources The documentation is always made in man pages (nroff formatted) or plain
ASCII files. All HTML files on the web site and in the release archives are
generated from the nroff/ASCII versions.
Please try to get the latest available sources to make your patches ### Test Cases
against. It makes the life of the developers so much easier. The very best is
if you get the most up-to-date sources from the git repository, but the
latest release archive is quite OK as well!
2.5 Document Since the introduction of the test suite, we can quickly verify that the main
features are working as they're supposed to. To maintain this situation and
improve it, all new features and functions that are added need to be tested
in the test suite. Every feature that is added should get at least one valid
test case that verifies that it works as documented. If every submitter also
posts a few test cases, it won't end up as a heavy burden on a single person!
Writing docs is dead boring and one of the big problems with many open source If you don't have test cases or perhaps you have done something that is very
projects. Someone's gotta do it. It makes it a lot easier if you submit a hard to write tests for, do explain exactly how you have otherwise tested and
small description of your fix or your new features with every contribution so verified your changes.
that it can be swiftly added to the package documentation.
The documentation is always made in man pages (nroff formatted) or plain ## Sharing Your Changes
ASCII files. All HTML files on the web site and in the release archives are
generated from the nroff/ASCII versions.
2.6 Test Cases ### How to get your changes into the main sources
Since the introduction of the test suite, we can quickly verify that the main Ideally you file a [pull request on
features are working as they're supposed to. To maintain this situation and github](https://github.com/curl/curl/pulls), but you can also send your plain
improve it, all new features and functions that are added need to be tested patch to [the curl-library mailing
in the test suite. Every feature that is added should get at least one valid list](https://curl.haxx.se/mail/list.cgi?list=curl-library).
test case that verifies that it works as documented. If every submitter also
posts a few test cases, it won't end up as a heavy burden on a single person!
If you don't have test cases or perhaps you have done something that is very Either way, your change will be reviewed and discussed there and you will be
hard to write tests for, do explain exactly how you have otherwise tested and expected to correct flaws pointed out and update accordingly, or the change
verified your changes. risk stalling and eventually just get deleted without action. As a submitter
of a change, you are the owner of that change until it has been merged.
3. Sharing Your Changes Respond on the list or on github about the change and answer questions and/or
fix nits/flaws. This is very important. We will take lack of replies as a
sign that you're not very anxious to get your patch accepted and we tend to
simply drop such changes.
3.1 How to get your changes into the main sources ### About pull requests
Ideally you file a pull request on github, but you can also send your plain With github it is easy to send a [pull
patch to the curl-library mailing list. request](https://github.com/curl/curl/pulls) to the curl project to have
changes merged.
Either way, your change will be reviewed and discussed there and you will be We prefer pull requests to mailed patches, as it makes it a proper git commit
expected to correct flaws pointed out and update accordingly, or the change that is easy to merge and they are easy to track and not that easy to loose
risk stalling and eventually just get deleted without action. As a submitter in a flood of many emails, like they sometimes do on the mailing lists.
of a change, you are the owner of that change until it has been merged.
Respond on the list or on github about the change and answer questions and/or When you ajust your pull requests after review, consider squashing the
fix nits/flaws. This is very important. We will take lack of replies as a commits so that we can review the full updated version more easily.
sign that you're not very anxious to get your patch accepted and we tend to
simply drop such changes.
3.2 About pull requests ### Making quality patches
With github it is easy to send a pull request to the curl project to have Make the patch against as recent sources as possible.
changes merged this way instead of mailing patches to the curl-library
mailing list. See https://github.com/curl/curl/pulls
We prefer pull requests as it makes it a proper git commit that is easy to If you've followed the tips in this document and your patch still hasn't been
merge and they are easy to track and not that easy to loose in a flood of incorporated or responded to after some weeks, consider resubmitting it to
many emails, like they sometimes do on the mailing lists. the list or better yet: change it to a pull request.
When you ajust your pull requests after review, consider squashing the ### Write good commit messages
commits so that we can review the full updated version more easily.
3.3 Making quality patches A short guide to how to write commit messages in the curl project.
Make the patch against as recent sources as possible.
If you've followed the tips in this document and your patch still hasn't been
incorporated or responded to after some weeks, consider resubmitting it to
the list or better yet: change it to a pull request.
3.5 Write good commit messages
A short guide to how to do fine commit messages in the curl project.
---- start ---- ---- start ----
[area]: [short line describing the main effect] [area]: [short line describing the main effect]
-- empty line --
[separate the above single line from the rest with an empty line]
[full description, no wider than 72 columns that describe as much as [full description, no wider than 72 columns that describe as much as
possible as to why this change is made, and possibly what things possible as to why this change is made, and possibly what things
it fixes and everything else that is related] it fixes and everything else that is related]
-- empty line --
[Bug: link to source of the report or more related discussion] [Bug: URL to source of the report or more related discussion]
[Reported-by: John Doe - credit the reporter] [Reported-by: John Doe - credit the reporter]
[whatever-else-by: credit all helpers, finders, doers] [whatever-else-by: credit all helpers, finders, doers]
---- stop ---- ---- stop ----
Don't forget to use commit --author="" if you commit someone else's work, Don't forget to use commit --author="" if you commit someone else's work,
and make sure that you have your own user and email setup correctly in git and make sure that you have your own user and email setup correctly in git
before you commit before you commit
3.6 Write Access to git Repository ### Write Access to git Repository
If you are a very frequent contributor, you may be given push access to the If you are a very frequent contributor, you may be given push access to the
git repository and then you'll be able to push your changes straight into the git repository and then you'll be able to push your changes straight into the
git repo instead of sending changes as pull requests or by mail as patches. git repo instead of sending changes as pull requests or by mail as patches.
Just ask if this is what you'd want. You will be required to have posted Just ask if this is what you'd want. You will be required to have posted
several high quality patches first, before you can be granted push access. several high quality patches first, before you can be granted push access.
3.7 How To Make a Patch with git ### How To Make a Patch with git
You need to first checkout the repository: You need to first checkout the repository:
git clone https://github.com/curl/curl.git git clone https://github.com/curl/curl.git
You then proceed and edit all the files you like and you commit them to your You then proceed and edit all the files you like and you commit them to your
local repository: local repository:
git commit [file] git commit [file]
As usual, group your commits so that you commit all changes that at once that As usual, group your commits so that you commit all changes that at once that
constitutes a logical change. See also section "3.5 Write good commit constitutes a logical change.
messages".
Once you have done all your commits and you're happy with what you see, you Once you have done all your commits and you're happy with what you see, you
can make patches out of your changes that are suitable for mailing: can make patches out of your changes that are suitable for mailing:
git format-patch remotes/origin/master git format-patch remotes/origin/master
This creates files in your local directory named NNNN-[name].patch for each This creates files in your local directory named NNNN-[name].patch for each
commit. commit.
Now send those patches off to the curl-library list. You can of course opt to Now send those patches off to the curl-library list. You can of course opt to
do that with the 'git send-email' command. do that with the 'git send-email' command.
3.8 How To Make a Patch without git ### How To Make a Patch without git
Keep a copy of the unmodified curl sources. Make your changes in a separate Keep a copy of the unmodified curl sources. Make your changes in a separate
source tree. When you think you have something that you want to offer the source tree. When you think you have something that you want to offer the
curl community, use GNU diff to generate patches. curl community, use GNU diff to generate patches.
If you have modified a single file, try something like: If you have modified a single file, try something like:
diff -u unmodified-file.c my-changed-one.c > my-fixes.diff diff -u unmodified-file.c my-changed-one.c > my-fixes.diff
If you have modified several files, possibly in different directories, you If you have modified several files, possibly in different directories, you
can use diff recursively: can use diff recursively:
diff -ur curl-original-dir curl-modified-sources-dir > my-fixes.diff diff -ur curl-original-dir curl-modified-sources-dir > my-fixes.diff
The GNU diff and GNU patch tools exist for virtually all platforms, including The GNU diff and GNU patch tools exist for virtually all platforms, including
all kinds of Unixes and Windows: all kinds of Unixes and Windows:
For unix-like operating systems: For unix-like operating systems:
https://savannah.gnu.org/projects/patch/ - [https://savannah.gnu.org/projects/patch/](https://savannah.gnu.org/projects/patch/)
https://www.gnu.org/software/diffutils/ - [https://www.gnu.org/software/diffutils/](https://www.gnu.org/software/diffutils/)
For Windows: For Windows:
http://gnuwin32.sourceforge.net/packages/patch.htm - [http://gnuwin32.sourceforge.net/packages/patch.htm](http://gnuwin32.sourceforge.net/packages/patch.htm)
http://gnuwin32.sourceforge.net/packages/diffutils.htm - [http://gnuwin32.sourceforge.net/packages/diffutils.htm](http://gnuwin32.sourceforge.net/packages/diffutils.htm)