submitting-patches
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
submitting-patches [2018/03/01 08:54] tmomas updated git link |
submitting-patches [2018/06/12 20:44] (current) sam0815 [Sending patches by Email] - update link to dev mailinglist |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Submitting patches ====== | ====== Submitting patches ====== | ||
| - | Patches can be submitted as a pull request on Github or via the mailing list.\\ | + | Patches can be submitted as a pull request on Github or via the mailing list. |
| Submissions should follow the following guidelines: | Submissions should follow the following guidelines: | ||
| Line 28: | Line 28: | ||
| * must have less than 75 characters per line | * must have less than 75 characters per line | ||
| * it will be committed to the source changelog, so __it should explain to a competent reader why you made this commit__.\\ Include symptoms of the failure you are fixing (log messages, error messages, etc.), it will be useful for\\ people searching the commit logs looking for a fix for their issue.\\ If a patch fixes a compile failure, include only the most relevant part of the failure log | * it will be committed to the source changelog, so __it should explain to a competent reader why you made this commit__.\\ Include symptoms of the failure you are fixing (log messages, error messages, etc.), it will be useful for\\ people searching the commit logs looking for a fix for their issue.\\ If a patch fixes a compile failure, include only the most relevant part of the failure log | ||
| - | * If you add support for new hardware: Include in your commit message a short description of the hardware and how to install LEDE on it. Have a look at the [[https://git.openwrt.org/?p=openwrt/openwrt.git&a=search&h=HEAD&st=commit&s=add+support+for|recent additions]] for some examples. | + | * If you add support for new hardware: Include in your commit message a short description of the hardware and how to install OpenWrt on it. Have a look at the [[https://git.openwrt.org/?p=openwrt/openwrt.git&a=search&h=HEAD&st=commit&s=add+support+for|recent additions]] for some examples. |
| * **all commits must contain ''%%Signed-off-by: My Name <my@email.address>%%'' where you write your real name and real email address**, in accordance with [[http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/submitting-patches.rst?id=HEAD#n416|Section 11 of the Linux Kernel patches guide]]. | * **all commits must contain ''%%Signed-off-by: My Name <my@email.address>%%'' where you write your real name and real email address**, in accordance with [[http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/submitting-patches.rst?id=HEAD#n416|Section 11 of the Linux Kernel patches guide]]. | ||
| Line 43: | Line 42: | ||
| ===== Working with Github ===== | ===== Working with Github ===== | ||
| - | There are Github mirrors of the source repository [[https://github.com/lede-project/source|here]].\\ | + | There are Github mirrors of the source repository [[https://github.com/openwrt/openwrt|here]].\\ |
| Fork the project to a public repo using Github web interface, clone the repo to your computer, create a branch for your changes, push these back to Github and submit a pull request. | Fork the project to a public repo using Github web interface, clone the repo to your computer, create a branch for your changes, push these back to Github and submit a pull request. | ||
| Line 87: | Line 86: | ||
| ===== Sending patches by Email ===== | ===== Sending patches by Email ===== | ||
| - | Send an email to the [[https://lists.infradead.org/mailman/listinfo/lede-dev|development mailing list]]. All patches need to be sent in the same format as those that are listed on [[https://patchwork.ozlabs.org/project/lede/list/|patchwork]]. If the patch does not get listed in patchwork then it won't get processed. | + | Send an email to the [[https://lists.openwrt.org/mailman/listinfo/openwrt-devel|development mailing list]]. All patches need to be sent in the same format as those that are listed on [[https://patchwork.ozlabs.org/project/lede/list/|patchwork]]. If the patch does not get listed in patchwork then it won't get processed. |
| Using **git send-email** is warmly recommended, as email clients tend to add spaces and screw up the formatting or add non-printable characters. | Using **git send-email** is warmly recommended, as email clients tend to add spaces and screw up the formatting or add non-printable characters. | ||
submitting-patches.1519894456.txt.gz · Last modified: 2018/03/01 08:54 by tmomas
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
