Add deprecation notice
[web.git] / development.txt
index e4fb09b768c0cc45bff0b16f0e139cdb241c6aa6..b813e6b2caec5f8fefa0e5914a5d7740d2acb43f 100644 (file)
@@ -57,17 +57,29 @@ 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
-https://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 https://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