|
603
by Dustin Kirkland
* CONTRIBUTING: |
1 |
Thanks for your interest in contributing to eCryptfs! |
2 |
||
3 |
Here are a few instructions to help get started... |
|
4 |
||
5 |
To contribute to ecryptfs-utils (user space): |
|
6 |
1) Create and login to your account |
|
7 |
- https://launchpad.net |
|
8 |
2) Ensure that you have published your public SSH |
|
9 |
- https://launchpad.net/~/+editsshkeys |
|
10 |
3) Download, install, and configure 'bzr' |
|
11 |
- http://wiki.bazaar.canonical.com/Download |
|
12 |
4) Branch the source code |
|
13 |
- bzr branch lp:ecryptfs |
|
14 |
5) File a bug against eCryptfs |
|
15 |
- https://bugs.launchpad.net/ecryptfs/+filebug |
|
16 |
6) Make your changes, and commit with an informative change log entry, |
|
17 |
and mention the bug number in the form 'LP: #xxxxxx' in the commit |
|
18 |
- bzr commit --fixes lp:xxxxxx |
|
19 |
7) Push your changes to your own branch |
|
20 |
- bzr push lp:~/ecryptfs/xxxxxx |
|
|
604
by Tyler Hicks
* CONTRIBUTING: |
21 |
8) When you're ready, you can propose your branch for merging |
|
603
by Dustin Kirkland
* CONTRIBUTING: |
22 |
- https://code.launchpad.net/~/ecryptfs/xxxxxx/+register-merge |
23 |
9) And we'll take it from there! |
|
24 |
||
25 |
To contribute to ecryptfs (kernel space): |
|
|
604
by Tyler Hicks
* CONTRIBUTING: |
26 |
1) You can typically develop fixes against Linus' tree |
27 |
- git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git |
|
28 |
However, new features should be developed against linux-next |
|
29 |
- git://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git |
|
30 |
2) Make your changes, signoff, and commit, following the guidelines in: |
|
|
603
by Dustin Kirkland
* CONTRIBUTING: |
31 |
- http://git.kernel.org/?p=linux/kernel/git/torvalds/linux.git;a=blob_plain;f=Documentation/SubmittingPatches;hb=HEAD |
32 |
3) Create a proper patch using |
|
33 |
- git format-patch |
|
|
604
by Tyler Hicks
* CONTRIBUTING: |
34 |
4) As SubmittingPatches suggests, please do a style check with |
35 |
scripts/checkpatch.pl, which can be found in the kernel source tree |
|
36 |
- http://git.kernel.org/?p=linux/kernel/git/torvalds/linux.git;a=blob_plain;f=scripts/checkpatch.pl;hb=HEAD |
|
37 |
5) It is common for first time contributors to use a mail client that mangles |
|
38 |
patches so you may want to verify that there are no known issues with the |
|
39 |
client that you use |
|
40 |
- http://git.kernel.org/?p=linux/kernel/git/torvalds/linux.git;a=blob_plain;f=Documentation/email-clients.txt;hb=HEAD |
|
41 |
6) Email your patch inline with, at least, the following headers: |
|
42 |
To: tyhicks@canonical.com |
|
43 |
Cc: ecryptfs@vger.kernel.org |