Development
===========
-include::menu.inc[]
-
== The Source Code
The LEDE project source code starts off with OpenWrt revision r49258. The code
minor tweaks were made to committer names and mail addresses.
All repositories can be browsed online through
-http://git.lede-project.org/[Gitweb] as well.
+https://git.lede-project.org/[Gitweb] as well.
=== Getting The _LEDE_ Code
accessible via both HTTP and HTTPS:
----
-git clone http://git.lede-project.org/source.git
+git clone https://git.lede-project.org/source.git
----
You can find a mirror of the repository on Github:
branches.
----
-git clone http://git.lede-project.org/openwrt/source.git
-git clone http://git.lede-project.org/openwrt/packages.git
-git clone http://git.lede-project.org/openwrt/feeds.git
-git clone http://git.lede-project.org/openwrt/docs.git
+git clone https://git.lede-project.org/openwrt/source.git
+git clone https://git.lede-project.org/openwrt/packages.git
+git clone https://git.lede-project.org/openwrt/feeds.git
+git clone https://git.lede-project.org/openwrt/docs.git
----
=== The Web Presence
projects web site will be reflected in our +web.git+ repository:
----
-git clone http://git.lede-project.org/web.git
+git clone https://git.lede-project.org/web.git
----
=== Submitting Patches
-The biggest difference is that we now accept pull requests. The tree that shall
-be pulled from needs to be hosted publicly. Small fixes and minor patches can
-also be submitted via the
-http://lists.infradead.org/mailman/listinfo/lede-dev[development mailing list].
-Submissions should follow these rules
+The biggest difference is that we now accept pull requests. Patches can be submitted as either a pull request on Github or small fixes and minor patches can also be submitted via the mailing list. Submissions should follow these rules:
+. A `Signed-off-by` line must be added to your commit / patch in accordance with Section 1.11 of the https://www.kernel.org/doc/Documentation/SubmittingPatches[Linux Kernel patches guide].
+.. Git: `git commit --signoff`
+.. Email: Just add line like `Signed-off-by: Random J Developer <random@developer.example.org>` to the top patch.
. TBD
-All patches need to be sent in a format that they are listed in http://patchwork.ozlabs.org/project/lede/list/[patchwork].
-If the patch does not get listed in patchwork then it won't get processed.
+==== Github
+
+There are Github mirrors of the https://github.com/lede-project/source[source] and https://github.com/lede-project/web[web] repos. Simply 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.
+
+For example, to submit a pull request for these web-pages, follow these instructions and then submit PR using Github web interface:
+----
+git clone git@github.com:<github username>/web.git
+git checkout -b <branch-name>
+<make changes to files>
+git commit --signoff
+git push --all
+----
+
+==== 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. For example, to print a patch for the most recent commit, `git format-patch -1 --stdout`. Double check that your output conforms before sending.
+
+=== Staging Trees
+
+To create yourself a staging tree on git.lede-project.org:
+----
+ssh git@git.lede-project.org "create lede/yournick/staging"
+ssh git@git.lede-project.org "desc lede/yournick/staging Staging tree of Your Name"
+----
=== Reporting Bugs
-. *All* bug reports need to be submitted via the
- http://lists.infradead.org/mailman/listinfo/lede-dev[development mailing list]
+. Please report your bugs using our https://bugs.lede-project.org/[issue tracker]
. When reporting bugs please make sure to
.. Name the tree/revision
.. Name the affected device
. Reporting a bug means that you reported a bug. It does not constitute a claim that
anyone has to work on fixing it.
. Pointless/vague/silly/... bugs reports will be ignored
-. Feature requests are not Bugs. They will also be ignored.
. The better your bug report, the more likely it is that it will be worked on.
-All bug reports need to be sent in a format so that they are listed in the issue
-tracker (__LINK__). If the bug report does not get listed in the issue tracker then
-it won't get processed.
-
=== Patch Merging And Tree Life Cycle