From 6351f20f7e528d2a239ff4889951e9783ad6fc91 Mon Sep 17 00:00:00 2001 From: Alex Ellis Date: Mon, 30 Dec 2019 09:33:28 +0000 Subject: [PATCH] Add link to the store --- CONTRIBUTING.md | 73 ++++++++----------------------------------------- 1 file changed, 11 insertions(+), 62 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c36f4f54..ef1631ac 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,9 @@ This project is licensed under the MIT License. ## Submitting a new template -New templates are not being accepted into the official project repository. We have extended the CLI so that you can create templates within your own public or private Git repositories and then pull them in to use in the CLI. +> Note: new templates are not being accepted into the official project repository, but you can still create your own templates and share them with the community. + +* We have extended the CLI so that you can create templates within your own public or private Git repositories and then pull them in to use in the CLI. Example: @@ -18,72 +20,19 @@ $ faas template pull https://github.com/owner/repo Multiple templates can be stored within a single Git repository. View [the CLI reference guide](https://github.com/openfaas/faas-cli) for how to build a template. -## Modifying templates - - ```./verify.sh``` can be utilized to verify your changes to templates in this repo. - -## Guidelines apply from main OpenFaaS repo - -See guide for [FaaS](https://github.com/openfaas/faas/blob/master/CONTRIBUTING.md) here. - -## Developer DCO (re-iteration from referenced CONTRIBUTING guide) - -### Sign your work - -> Note: all of the commits in your PR/Patch must be signed-off. - -The sign-off is a simple line at the end of the explanation for a patch. Your -signature certifies that you wrote the patch or otherwise have the right to pass -it on as an open-source patch. The rules are pretty simple: if you can certify -the below (from [developercertificate.org](http://developercertificate.org/)): +* We have also created a Template Store, where templates that are useful for the community and that follow a series of guidelines can be submitted ``` -Developer Certificate of Origin -Version 1.1 - -Copyright (C) 2004, 2006 The Linux Foundation and its contributors. -1 Letterman Drive -Suite D4700 -San Francisco, CA, 94129 - -Everyone is permitted to copy and distribute verbatim copies of this -license document, but changing it is not allowed. - -Developer's Certificate of Origin 1.1 - -By making a contribution to this project, I certify that: - -(a) The contribution was created in whole or in part by me and I - have the right to submit it under the open source license - indicated in the file; or - -(b) The contribution is based upon previous work that, to the best - of my knowledge, is covered under an appropriate open source - license and I have the right under that license to submit that - work with modifications, whether created in whole or in part - by me, under the same open source license (unless I am - permitted to submit under a different license), as indicated - in the file; or - -(c) The contribution was provided directly to me by some other - person who certified (a), (b) or (c) and I have not modified - it. - -(d) I understand and agree that this project and the contribution - are public and that a record of the contribution (including all - personal information I submit with it, including my sign-off) is - maintained indefinitely and may be redistributed consistent with - this project or the open source license(s) involved. +$ faas template store list +$ faas template store pull ``` -Then you just add a line to every git commit message: - - Signed-off-by: Joe Smith +See the [openfaas/store](https://github.com/openfaas/store) here -Use your real name (sorry, no pseudonyms or anonymous contributions.) +## Modifying templates -If you set your `user.name` and `user.email` git configs, you can sign your -commit automatically with `git commit -s`. + ```./verify.sh``` can be utilized to verify your changes to templates in this repo. -* Please sign your commits with `git commit -s` so that commits are traceable. +## Guidelines apply from main OpenFaaS repo +See guide for [OpenFaaS](https://github.com/openfaas/faas/blob/master/CONTRIBUTING.md) here.