summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorShankho Boron Ghosh <shankhoghosh123@gmail.com>2020-11-16 19:58:11 +0530
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2020-11-18 15:12:29 +0000
commit4c924635db7b5e7cba7ad7372f47321b479eeb93 (patch)
tree9d7091dc79fb9a156dc37ce79fbe8604438388d3
parenta1a0a4900c523ace3c72334e9f6d64f68d4fdb1c (diff)
Added Contribution Checklist
Added comprehensive tasklist as a guideline for contributions in How To Contribute section. Also, minor fixup of API reference : 0_api-introduction. v2: Added item : Is a backport to a release branch required ? Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com> Change-Id: I122f2093bd8360be4082497e0cadb67ca67d6d4e Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25580 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> (cherry picked from commit c04ab11b946684902e3e39aef475a2d16c09e1c4) Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25599
-rw-r--r--docs/4_APIs_and_Services/4.1_API_Reference/0_api-introduction.md5
-rw-r--r--docs/5_How_To_Contribute/9_Contribution_Checklist.md60
-rw-r--r--mkdocs.yml2
3 files changed, 64 insertions, 3 deletions
diff --git a/docs/4_APIs_and_Services/4.1_API_Reference/0_api-introduction.md b/docs/4_APIs_and_Services/4.1_API_Reference/0_api-introduction.md
index e02f6db..4822bf0 100644
--- a/docs/4_APIs_and_Services/4.1_API_Reference/0_api-introduction.md
+++ b/docs/4_APIs_and_Services/4.1_API_Reference/0_api-introduction.md
@@ -1,7 +1,6 @@
-
-<!-----
+---
title: API Reference
------>
+---
# Available APIs
diff --git a/docs/5_How_To_Contribute/9_Contribution_Checklist.md b/docs/5_How_To_Contribute/9_Contribution_Checklist.md
new file mode 100644
index 0000000..75dc2fe
--- /dev/null
+++ b/docs/5_How_To_Contribute/9_Contribution_Checklist.md
@@ -0,0 +1,60 @@
+---
+title: Contribution Checklist
+---
+
+**Open Source Code Contribution Checklist**
+
+## General
+- [ ] Does the component have a name ? (Pick one fitting the purpose and the project.)
+- [ ] Is a separate git repo required for the component ?
+- [ ] Does the component have a README.md containing all basic information about it ?
+- [ ] Description.
+- [ ] Dependencies.
+- [ ] Build instructions.
+- [ ] Installation instructions.
+- [ ] Usage instructions.
+- [ ] Example invocations.
+- [ ] Does the component have a CONTRIBUTIONS.md file? (Containing all necessary information on how to contribute, e.g. pointing to project website? )
+
+## License
+ - [ ] Is the license an OSI approved open source software license?
+ - [ ] Are all files under an OSI approved open source license?
+ - [ ] Does the component have a LICENSE (or COPYING) file detailing the license of the code?
+ - [ ] Do the source code files have the license mentioned in the header?
+ - [ ] Do the source code files have an SPDX tag? (Note: An SPDX tag can be used in a file header instead of the license note)
+ - [ ] Are there files with other licenses in their header?
+ - [ ] If so, LICENSE should be the for the majority of the files and LICENSE.xyz for the exceptions.
+
+## docs/
+ - [ ] Are there docs/ folder for the component ?
+ - [ ] e.g. Are all APIs described inclusive description, usage and example invocations ?
+ - [ ] e.g. Are all cmdline tools or options described in the documentation ?
+ - [ ] e.g. Is the program flow described ?
+ - [ ] Contain Changelog.md ? (Keep track of major changes in the changelog.)
+
+## tests/
+ - [ ] Must have tests available.
+ - [ ] Must have simple invocation scripts available.
+ - [ ] Must have instructions for CI available.
+ - [ ] Must contribute CI test definitions.
+
+## Git repository
+ - [ ] Must have: a .gitreview file.
+ - [ ] Option: Can have a .gitignore file.
+ - [ ] Option: Can have a .editorconfig file.
+ - [ ] All code needs to build against master.
+ - [ ] Is a backport to a release branch required ?
+ - [ ] Code contributions submitted need to have a Sign-off-by! (Follow [**DCO**](https://developercertificate.org/).)
+
+## Yocto/OE
+ - [ ] Recipes need to follow the guidelines of : [**new-recipe-writing-a-new-recipe**](https://www.yoctoproject.org/docs/latest/mega-manual/mega-manual.html#new-recipe-writing-a-new-recipe).
+ - [ ] Recipes follow the [**bitbake style guide**](https://www.openembedded.org/wiki/Styleguide).
+ - [ ] Your 'meta-*' layer needs to pass the yocto-check-layer tool.
+
+## Gerrit Reviews
+**All gerrit reviews need to be addressed. All issues are to be discussed with the experts.**
+
+ - [ ] Issues are to be discussed in the EG first.
+ - [ ] Consent needs to be reached.
+ - [ ] Gerrit commits need two upvotes (not from authors!) to be merged.
+ - [ ] Uploads should be 'ready for review' or marked 'WIP'. \ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index 9c03dde..5d69bf8 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -16,5 +16,7 @@ plugins:
markdown_extensions:
- pymdownx.superfences
+ - pymdownx.tasklist:
+ custom_checkbox: true