Difference between revisions of "Contribute"

(Mailing patches to samba-technical)
(link to being granted access)
 
(30 intermediate revisions by 2 users not shown)
Line 13: Line 13:
 
* Create patches (C and Python developers)
 
* Create patches (C and Python developers)
 
* Anything else you can imagine
 
* Anything else you can imagine
 +
 +
'''Whenever participating in the Samba community, please follow and respect the guidelines in [[How to do Samba: Nicely]]'''
  
 
= Submitting Patches via GitLab =
 
= Submitting Patches via GitLab =
Line 24: Line 26:
 
  git clone https://git.samba.org/samba.git
 
  git clone https://git.samba.org/samba.git
  
You should develop new Samba features and fix bugs first in the master branch.
+
You should develop new Samba features and fix bugs first in the '''master''' branch before attempting any [[Samba_Release_Planning#Release_Branch_Checkin_Procedure|backports]].
  
Run the [[Package_Dependencies_Required_to_Build_Samba#Verified_Package_Dependencies|bootstrap.sh script]] for your operating system from '''bootstrap/generated-dists/'''.
+
Run the [[Package_Dependencies_Required_to_Build_Samba#Verified_Package_Dependencies|bootstrap.sh script]] for your operating system from '''bootstrap/generated-dists/''' to install build dependencies and prepare your system to build samba.
  
 
==First Merge Request==
 
==First Merge Request==
  
The [[Using Git for Samba Development]] page has details on how to prepare patches using git.
+
Making your first merge request is straight-forward, provided you follow these steps carefully.
 +
 
 +
===Start small===
 +
 
 +
Unless you are just submitting a spelling fix or a similar ''one line'' change, then you '''must''' review the '''[[Creating_Gitlab_Merge_Requests|full instructions on creating Samba patch series]]''' for instructions on what will need to be ''in'' the merge request.  Do this '''before''' creating your patches to avoid rework.
  
 
===Obtain a GitLab.com account===
 
===Obtain a GitLab.com account===
Line 50: Line 56:
  
 
  ERROR: Job failed: execution took longer than 1h0m0s seconds
 
  ERROR: Job failed: execution took longer than 1h0m0s seconds
 
 
  The script exceeded the maximum execution time set for the job
 
  The script exceeded the maximum execution time set for the job
  
 
===Prepare your patches===
 
===Prepare your patches===
  
Samba has coding standards, please read [https://git.samba.org/?p=samba.git;a=blob_plain;f=README.Coding README.Coding] in your source checkout.
+
Samba has coding standards, please read [https://gitlab.com/samba-team/samba/-/blob/master/README.Coding.md README.Coding.md] in your source checkout.
 +
 
 +
* Each patch should be as small as possible, i.e. changes only one thing. This makes review easier.
 +
* The patch should have an appropriate commit description.
 +
* Patches that fix a bug should contain an appropriate <code>BUG</code> tag.
 +
 
 +
==== Samba Copyright and Community Policies ====
  
When [[Using Git for Samba Development|preparing your patches]] please ensure you add [[CodeReview#commit_message_tags|Signed-off-by tags]] to your commits, and follow the [https://www.samba.org/samba/devel/copyright-policy.html Samba copyright policy].
+
'''Whenever participating in the Samba community, please follow and respect the guidelines in [[How to do Samba: Nicely]]'''
  
==== A good commit message ====
+
Samba has a [https://www.samba.org/samba/devel/copyright-policy.html Copyright Policy] that requires mandatory tags on every git commit. When [[Creating_a_Samba_patch_series|preparing your patches]] '''please ensure you add [[CodeReview#commit_message_tags|Signed-off-by tags]] to your commits'''.
  
Good commit messages are very important. Commits should always be separated in meaningful pieces.
+
Samba is a project with distributed copyright ownership and so [https://www.samba.org/samba/devel/copyright-policy.html following our Copyright Policy] ensures we are all clear that you have the permission and intention to contribute to Samba, and the licence you make those contributions under.
Please make sure that your commit messages include at least the following information:
 
  
* A '''short''' summary of the fix/feature including the Samba version and component followed by a blank line.
+
==== A good commit message ====
* A more verbose description.
 
* A bug number if available (required for [[Samba_Release_Planning#Release_Branch_Checkin_Procedure|backports to a released branch]], so please file a bug first)
 
* Your [[CodeReview#commit_message_tags|Signed-off-by tag]] per the [https://www.samba.org/samba/devel/copyright-policy.html Samba copyright policy]
 
  
Example:
+
{{:A_Good_Git_Commit_Message}}
 
s3:smbd: Add new funky shiny and groovy feature
 
 
The funky shiny and groovy feature has been added to
 
be able to do whatever you like. A typical usecase is the
 
following.
 
 
BUG: https://bugzilla.samba.org/show_bug.cgi?id=1
 
 
Signed-off-by: Author <author@example.org>
 
  
 
==== Include tests ====
 
==== Include tests ====
 
+
{{:Writing_Tests_summary}}
Most changes to Samba should have a test to demonstrate the bug being fixed, or test the feature being added.  Most tests are run using 'make test' from a Samba source tree. 
 
* [[Writing Torture Tests]]: smbtorture in the ''source4/torture'' directory and provides direct C protocol tests.
 
* [[Writing Python Tests]]: If the protocol under test is [[DCERPC]], then [[PIDL]] will have already auto-generated [[Python]] bindings.  Likewise LDAP is easily accessed via [[LDB]].
 
* [[Writing cmocka Tests]]: Idea for unit tests of C functions.
 
* [[LDB]]: Tests for LDB are in <code>lib/ldb/tests</code> and are run from <code>make test</code> within <code>lib/ldb</code>
 
  
 
===Push back to GitLab and make your first merge request===
 
===Push back to GitLab and make your first merge request===
Line 98: Line 90:
 
The merge request will be [https://gitlab.com/samba-team/samba/-/merge_requests listed for review] by [https://www.samba.org/samba/team/ Samba Team members] who will post comments on your merge request.
 
The merge request will be [https://gitlab.com/samba-team/samba/-/merge_requests listed for review] by [https://www.samba.org/samba/team/ Samba Team members] who will post comments on your merge request.
  
==Subsequent Merge Requests==
+
Review the [[Creating_Gitlab_Merge_Requests#Examples|examples of a good/bad merge request]] prior to submitting your merge request.
 +
 
 +
==Subsequent Merge Requests (and complex first requests)==
 +
 
 +
Because the Samba Team operates additional GitLab runners to support the full testsuite, we have a slightly unusual process with a single shared ''sandbox'' shared development repository, rather than the per-user fork you will have just created.
 +
 
 +
* After your first merge request has been reviewed, and now we know you are a genuine contributor, you may be '''[[Samba_on_GitLab#Getting_Access|granted access]]''' to the [https://gitlab.com/samba-team/devel/samba samba devel gitlab repo]. 
 +
* If your first MR is complex, it is likely that your reviewer will push it again there (and link to the pipeline), or ask you to. 
 +
* If you do so, just close the original MR and open a new one, saying ''This replaces !123 submitted from a private fork''.
 +
 
 +
Likewise, subsequent merge requests should also be made from '''[https://gitlab.com/samba-team/devel/samba this repository]'''.
 +
 
 +
===Building a Samba patch series===
  
After your first merge request has been approved, you will be granted access to the [https://gitlab.com/samba-team/devel/samba samba devel gitlab repo]. Subsequent merge requests should be made from this repository, because more tests are run than are possible on the free runners attached to your personal repo.
+
By this point you may be making fairly complex changes to Samba, so review '''[[Creating_a_Samba_patch_series|creating a samba patch series]]''' for detailed information on how to build [[Creating_a_Samba_patch_series|a polished series of changes to Samba]] ready for [[CodeReview|code review]].
  
 
===Shared development repo: Code of conduct===
 
===Shared development repo: Code of conduct===
Line 108: Line 112:
 
  $USER/topic
 
  $USER/topic
  
In return you get a full CI run using Samba Team provided resources.  That in turn makes it easier for Samba Team members doing [[CodeReview|Code Review]] as your patches will work first time, and they can see proof of that.
+
In return you get a full CI run using Samba Team provided resources.  That in turn makes it easier for Samba Team members doing [[CodeReview|Code Review]] as your patches will work the first time, and they can see proof of that.
  
 
If you describe your work in the branch name, this will make [[Samba_CI_on_gitlab#Creating_a_merge_request|generating a merge request]] easier, as the branch name becomes the template title and allows ongoing distinct merge requests.
 
If you describe your work in the branch name, this will make [[Samba_CI_on_gitlab#Creating_a_merge_request|generating a merge request]] easier, as the branch name becomes the template title and allows ongoing distinct merge requests.
Line 136: Line 140:
  
 
=Code Review and using autobuild to merge into master=
 
=Code Review and using autobuild to merge into master=
 +
==Effective Review==
 +
 +
As the submitter, is is '''your responsibility''' to make the most of [[CodeReview|code review]]. The reviewer will likely only point out a '''single instance''' of any given problem.  You are expected to find every instance of this mistake and fix it throughout the code before re-submitting.
  
Once submitted, Samba Team members (in particular) will [[CodeReview|review your changes]], and post comments to you either on your merge request.  Broader discussions happen on the list, so please ensure you are [https://lists.samba.org/mailman/listinfo/samba-technical subscribed to samba-technical] also.
+
==Review process==
 +
 
 +
Once submitted, Samba Team members (in particular) will [[CodeReview|review your changes]], and post comments to you on your merge request.  Broader discussions happen on our mailing list, so please ensure you are [https://lists.samba.org/mailman/listinfo/samba-technical subscribed to samba-technical] also.
  
 
Patches from non-samba team members require a minimum of 2 reviews from samba team members prior to patches being merged.
 
Patches from non-samba team members require a minimum of 2 reviews from samba team members prior to patches being merged.
Line 160: Line 169:
 
=Mailing patches to samba-technical=
 
=Mailing patches to samba-technical=
  
While not ideal, submitting patches via the mailing list is possible and they may still be considered. To submit patches, [[Using_Git_for_Samba_Development#Creating_patches_if_you_don.27t_have_write_access_to_git.samba.org_repositories|use git format-patch]] and mail your patches to the [https://lists.samba.org/mailman/listinfo/samba-technical samba-technical mailing list].
+
A very small number of patches to Samba are contributed directly via the mailing list. To submit patches, [[Using_Git_for_Samba_Development#Creating_patches_if_you_don.27t_have_write_access_to_git.samba.org_repositories|use git format-patch]] and mail your patches to the [https://lists.samba.org/mailman/listinfo/samba-technical samba-technical mailing list].
 +
 
 +
'''Please include your [[CodeReview#commit_message_tags|Signed-off-by tag]] per the [https://www.samba.org/samba/devel/copyright-policy.html Samba copyright policy]'''.
  
 
The required format for patch sets is a single-file bundle attached to the email you send to the list. Bundling can be automated by invoking:
 
The required format for patch sets is a single-file bundle attached to the email you send to the list. Bundling can be automated by invoking:
Line 166: Line 177:
 
  git format-patch --stdout origin/master > master-featureX-01.patches.txt
 
  git format-patch --stdout origin/master > master-featureX-01.patches.txt
  
The disadvantages to this approach is that:
+
The advantages to this approach is that:
* your patches risk being missed by an interested samba team member.
+
* '''This is an e-mail based process''' similar to that historically used by other Free Software projects of our era.
 +
 
 +
The disadvantages to this approach are that:
 +
* '''This is essentially a manual process''' at our end.
 +
* '''Subscription is still required''' to post to <code>samba-technical</code> (and you will need to follow our [https://www.samba.org/samba/devel/copyright-policy.html Samba copyright policy]).
 +
* Your patches risk being missed by an interested samba team member.
 
* No instant feedback to you is possible regarding compilation errors and test failures
 
* No instant feedback to you is possible regarding compilation errors and test failures
* CI testing is still required, so a Samba developer will need to submit the patch to GitLab for you
+
* CI testing is still required: A Samba developer will submit the patch to GitLab for you and advise you of the (URL to the) results.
  
Submitting a merge request is therefore preferred, because the latest version of your patches remain in our [https://gitlab.com/samba-team/samba/-/merge_requests list of outstanding merge requests] and so will not be forgotten.
+
'''Please submit a merge request if you can''', because the latest version of your patches become persistent in our [https://gitlab.com/samba-team/samba/-/merge_requests list of outstanding merge requests] and so will not be forgotten.
  
 
== git send-email ==
 
== git send-email ==
Line 179: Line 195:
 
=[https://bugzilla.samba.org Bugzilla]=
 
=[https://bugzilla.samba.org Bugzilla]=
  
We prefer that new patches for master are not submitted to [https://bugzilla.samba.org Bugzilla] alone, for similar reasons.  Please submit the patches to GitLab instead (note the merge request in the URL on the bug).   
+
We '''strongly''' prefer that new patches for master '''are not submitted to [https://bugzilla.samba.org Bugzilla] alone''', for similar reasons.  Please submit the patches to '''GitLab''' instead (note the merge request in the ''URL'' on the bug).   
  
 
Bugzilla is used however for the [[Samba_Release_Planning#Release_Branch_Checkin_Procedure|Release Branch Check-in Procedure]].
 
Bugzilla is used however for the [[Samba_Release_Planning#Release_Branch_Checkin_Procedure|Release Branch Check-in Procedure]].
 
=Policies=
 
Regardless of how you send us your patches, please ensure you have added [[CodeReview#commit_message_tags|Signed-off-by tags]] to your commits, and follow the [https://www.samba.org/samba/devel/copyright-policy.html Samba copyright policy]
 
 
Whenever participating in the Samba community, please follow and respect the guidelines in [[How to do Samba: Nicely]]
 

Latest revision as of 22:48, 18 June 2020

How to contribute to Samba?

Like all OpenSource projects, Samba is reliant on volunteers. You don't need special skill to help this project. Everybody can help! :-)

There are several category groups you can work on, e.g.:

Whenever participating in the Samba community, please follow and respect the guidelines in How to do Samba: Nicely

Submitting Patches via GitLab

The preferred method for submitting patches to samba is via the official mirror on GitLab. For more information see Samba on GitLab.

Prepare your development environment

Check out a copy of Samba locally:

git clone https://git.samba.org/samba.git

You should develop new Samba features and fix bugs first in the master branch before attempting any backports.

Run the bootstrap.sh script for your operating system from bootstrap/generated-dists/ to install build dependencies and prepare your system to build samba.

First Merge Request

Making your first merge request is straight-forward, provided you follow these steps carefully.

Start small

Unless you are just submitting a spelling fix or a similar one line change, then you must review the full instructions on creating Samba patch series for instructions on what will need to be in the merge request. Do this before creating your patches to avoid rework.

Obtain a GitLab.com account

Samba development is done on GitLab.com so you will need to Register a new user account. You can sign in with you GitHub account if you have one

Fork the Samba repo (just until we get to know you)

First fork the samba GitLab.com official mirror.

In the git checkout you made earlier, add a remote for your new gitlab fork (the URL will be in the GitLab UI under the blue Clone button):

$ git remote add gitlab-$USER git@gitlab.com:$USER/samba.git

Change the 1hr default CI timeout

By default projects on gitlab.com have a 1 hour timeout set on pipelines. This must be changed in the project settings. We suggest using a timeout of 3 hours, which is still permitted on the free runners.

Otherwise, once you push your changes back, you will see errors like this:

ERROR: Job failed: execution took longer than 1h0m0s seconds
The script exceeded the maximum execution time set for the job

Prepare your patches

Samba has coding standards, please read README.Coding.md in your source checkout.

  • Each patch should be as small as possible, i.e. changes only one thing. This makes review easier.
  • The patch should have an appropriate commit description.
  • Patches that fix a bug should contain an appropriate BUG tag.

Samba Copyright and Community Policies

Whenever participating in the Samba community, please follow and respect the guidelines in How to do Samba: Nicely

Samba has a Copyright Policy that requires mandatory tags on every git commit. When preparing your patches please ensure you add Signed-off-by tags to your commits.

Samba is a project with distributed copyright ownership and so following our Copyright Policy ensures we are all clear that you have the permission and intention to contribute to Samba, and the licence you make those contributions under.

A good commit message

Good commit messages are very important. Commits should always be separated in meaningful pieces. Please make sure that your commit messages include at least the following information:

Example:

s3:smbd: Add new funky shiny and groovy feature

The funky shiny and groovy feature has been added to
be able to do whatever you like. A typical usecase is the
following.

BUG: https://bugzilla.samba.org/show_bug.cgi?id=1

Signed-off-by: Author <author@example.org>

Include tests

Most changes to Samba should have a test to demonstrate the bug being fixed, or test the feature being added. Most tests are run using 'make test' from a Samba source tree.

See writing and running Samba tests but in particular:

  • Writing Torture Tests: smbtorture in the source4/torture directory and provides direct C protocol tests.
  • Writing Python Tests: If the protocol under test is DCERPC, then PIDL will have already auto-generated Python bindings. Likewise LDAP is easily accessed via LDB.
  • Writing cmocka Tests: Idea for unit tests of C functions.
  • LDB: Tests for LDB are in lib/ldb/tests and are run from make test within lib/ldb
  • CTDB: Tests for CTDB are written as shell scripts under ctdb/tests and are run from make test within ctdb

Push back to GitLab and make your first merge request

Push to your repo (rather than git.samba.org, which will be origin) with:

$ git push gitlab-$USER -f

After pushing back to your fork on gitlab.com you can submit a merge request. (The push will give a URL for you to click).

The merge request will be listed for review by Samba Team members who will post comments on your merge request.

Review the examples of a good/bad merge request prior to submitting your merge request.

Subsequent Merge Requests (and complex first requests)

Because the Samba Team operates additional GitLab runners to support the full testsuite, we have a slightly unusual process with a single shared sandbox shared development repository, rather than the per-user fork you will have just created.

  • After your first merge request has been reviewed, and now we know you are a genuine contributor, you may be granted access to the samba devel gitlab repo.
  • If your first MR is complex, it is likely that your reviewer will push it again there (and link to the pipeline), or ask you to.
  • If you do so, just close the original MR and open a new one, saying This replaces !123 submitted from a private fork.

Likewise, subsequent merge requests should also be made from this repository.

Building a Samba patch series

By this point you may be making fairly complex changes to Samba, so review creating a samba patch series for detailed information on how to build a polished series of changes to Samba ready for code review.

Shared development repo: Code of conduct

Use our shared development repository only to develop Samba. Don't overwrite the work of others. Prefix branches with your gitlab username, eg:

$USER/topic

In return you get a full CI run using Samba Team provided resources. That in turn makes it easier for Samba Team members doing Code Review as your patches will work the first time, and they can see proof of that.

If you describe your work in the branch name, this will make generating a merge request easier, as the branch name becomes the template title and allows ongoing distinct merge requests.

Step by step instructions

Add a git reference to the gitlab remote repository:

$ git remote add gitlab-ci git@gitlab.com:samba-team/devel/samba.git

Name your branch for our shared repo:

$ git checkout -b $USER/foo

Push the current branch, overwriting any other changes there:

$ git push gitlab-ci -f

Pipelines, Successful tests and Debugging CI failures

Pushing branches to samba devel gitlab repo will initiate a full CI build test.

Code Review and using autobuild to merge into master

Effective Review

As the submitter, is is your responsibility to make the most of code review. The reviewer will likely only point out a single instance of any given problem. You are expected to find every instance of this mistake and fix it throughout the code before re-submitting.

Review process

Once submitted, Samba Team members (in particular) will review your changes, and post comments to you on your merge request. Broader discussions happen on our mailing list, so please ensure you are subscribed to samba-technical also.

Patches from non-samba team members require a minimum of 2 reviews from samba team members prior to patches being merged.

Outside contributors are welcome to review patches also, this is a good way to learn more about Samba!

Merging patches from GitLab (for Samba Team members)

If the developer has created a merge request, then to merge, download the patch with (eg)

https://gitlab.com/samba-team/samba/merge_requests/12.patch

Add review tags and then git autobuild locally. The merge button sadly doesn't work.

After the autobuild completes, please close the merge request using the git hash finally assigned in Samba.org's git master in the comment like:

Merged into master as <git hash> for Samba <next version>.

See for example this closed merge request.

Mailing patches to samba-technical

A very small number of patches to Samba are contributed directly via the mailing list. To submit patches, use git format-patch and mail your patches to the samba-technical mailing list.

Please include your Signed-off-by tag per the Samba copyright policy.

The required format for patch sets is a single-file bundle attached to the email you send to the list. Bundling can be automated by invoking:

git format-patch --stdout origin/master > master-featureX-01.patches.txt

The advantages to this approach is that:

  • This is an e-mail based process similar to that historically used by other Free Software projects of our era.

The disadvantages to this approach are that:

  • This is essentially a manual process at our end.
  • Subscription is still required to post to samba-technical (and you will need to follow our Samba copyright policy).
  • Your patches risk being missed by an interested samba team member.
  • No instant feedback to you is possible regarding compilation errors and test failures
  • CI testing is still required: A Samba developer will submit the patch to GitLab for you and advise you of the (URL to the) results.

Please submit a merge request if you can, because the latest version of your patches become persistent in our list of outstanding merge requests and so will not be forgotten.

git send-email

Using git send-email in the Samba project is not permitted. Doing so will cause, without manual work by the recipient, your patch to be credited to samba-technical@... not your own e-mail address.

Bugzilla

We strongly prefer that new patches for master are not submitted to Bugzilla alone, for similar reasons. Please submit the patches to GitLab instead (note the merge request in the URL on the bug).

Bugzilla is used however for the Release Branch Check-in Procedure.