From 76eaa121b810c045a59c82a615873d9f8255655b Mon Sep 17 00:00:00 2001 From: Florens Verschelde Date: Fri, 11 Aug 2023 15:51:02 +0200 Subject: [PATCH] docs(README): clarify contribution guidelines and licensing (#10) --- README.md | 29 ++++++++++++++++++++++------- 1 file changed, 22 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8510c70..6cb2016 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,27 @@ -image +# StackBlitz Starter Templates -### About the project +## About this repository -StackBlitz utilizes git repositories as the source of the Starters on the [stackblitz.com](https://stackblitz.com) platform. -Some of these starters are provided by various frameworks' respective communities (see e.g. the [Nuxt repository](https:github.com/nuxt/starter/tree/v3-stackblitz)) +StackBlitz uses Git repositories as the source of the __starter templates__ on [stackblitz.com](https://stackblitz.com). This repository contains the source code for several starter templates maintained by the StackBlitz team and community. -This repository provides the source for the remaining starters. +Some open-source projects maintain starter templates in their own repositories. For examples, see the [create-vite templates](https://github.com/vitejs/vite/tree/main/packages/create-vite) and the [`nuxt/starter` repository](https:github.com/nuxt/starter/tree/v3-stackblitz). -#### Note +## Contributing to this repository -This repository doesn't specify the existence or specific listing of the starters on the StackBlitz pages. +Contributions to this repository are welcome. We ask that contributors first open an issue before opening a pull request for non-trivial changes, such as: + +1. Adding a new template. +2. Upgrading a template’s npm dependencies to new major versions. +3. Changing many files in an existing template (except for formatting or cosmetic changes). + +__Please note:__ the presence of a starter template in this repository does not guarantee that this template will be included on stackblitz.com. The list of starter templates on stackblitz.com (pictured below) is currently hand-picked by the StackBlitz team. + +Screenshot of the list of starter templates on stackblitz.com + +## License + +The contents of this repository are made available under the terms of the [MIT License](./LICENSE). + +By contributing code changes to this repository, you agree to StackBlitz distributing those code changes under this license. + +Note that each starter template in this repository may specify — but not directly include — dependencies which are licensed separately by their respective authors. Please check licensing requirements for the dependencies and software packages you use.