Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(readme): clarify contribution guidelines and licensing #10

Merged
merged 1 commit into from
Aug 11, 2023
Merged

docs(readme): clarify contribution guidelines and licensing #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 22 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,27 @@
<img width="872" alt="image" src="https://user-images.githubusercontent.com/1511906/223094313-879ff9ca-9825-4335-87f6-b32d94939945.png">
# 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.

<img width="872" alt="Screenshot of the list of starter templates on stackblitz.com" src="https://user-images.githubusercontent.com/1511906/223094313-879ff9ca-9825-4335-87f6-b32d94939945.png">

## 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.