Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/dotnet/spa-templates.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArtak <34246760+mkArtakMSFT@users.noreply.github.com>2021-09-11 07:16:10 +0300
committerGitHub <noreply@github.com>2021-09-11 07:16:10 +0300
commitd63bb5605aa08c18bf07340d8cefa06db22cf74d (patch)
treed497d8b500a76b1d1d63a024d302be263f138ca3
parent796e4363976fbd719468dc9466aa333ae82f7ae3 (diff)
Add readme, contributing guide, and PR template (#18)
-rw-r--r--.github/PULL_REQUEST_TEMPLATE/projectTemplate.md5
-rw-r--r--CONTRIBUTING.md18
-rw-r--r--README.md15
3 files changed, 38 insertions, 0 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE/projectTemplate.md b/.github/PULL_REQUEST_TEMPLATE/projectTemplate.md
new file mode 100644
index 0000000..25fcf00
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/projectTemplate.md
@@ -0,0 +1,5 @@
+Please use this template for each submission
+
+```markdown
+- [Template name](https://www.nuget.org/packages/**packageName**/) - ![GitHub stars](https://img.shields.io/github/stars/**org**/**repo**?style=flat-square&cacheSeconds=604800&logo=microsoft) ![last commit](https://img.shields.io/github/last-commit/**org**/**repo**?style=flat-square&cacheSeconds=86400) Short description of the template.
+``` \ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..3a72c01
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,18 @@
+# How to contribute
+
+## Add to the community ASP.NET Core SPA templates list
+
+You can add a project template to the community-owned ASP.NET Core SPA templates listing by submitting a pull request to update [README.md](https://github.com/dotnet/spa-templates/blob/main/README.md).
+
+Please ensure your pull request adheres to the following:
+
+* Make an individual pull request for each new project template listing.
+* Use the following format: \[NAME\]\(TEMPLATE PACKAGE LINK\) - DESCRIPTION.
+* Keep descriptions simple.
+* End all descriptions with a period.
+* Remove trailing whitespace.
+* Add new listings in alphabetical order.
+* Project templates should be of high quality, maintained, and follow the patterns and conventions used by the templates maintained in this repo.
+* Project templates should be open source and should reference the source project from the package metadata.
+
+See the ASP.NET Core docs for details on [integrating ASP.NET Core with frontend JavaScript frameworks](https://aka.ms/aspnetcorespa) and the .NET docs for instructions on [creating .NET project templates](https://docs.microsoft.com/dotnet/core/tutorials/cli-templates-create-project-template).
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6e24dfa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# ASP.NET Core Single Page App templates
+
+This repo is home for the ASP.NET Core Single Page App (SPA) project templates for Angular and React that ship as part of the .NET SDK, as well as a listing of community provided templates for using ASP.NET Core with other frontend JavaScript frameworks.
+
+## Community templates
+
+This section is for community project templates for using ASP.NET Core with various frontend JavaScript frameworks.
+
+> See the [contributing guide](https://github.com/dotnet/spa-templates/blob/main/CONTRIBUTING.md) for details on how to add a project template to this list.
+
+<!--
+Please use this template for each submission:
+
+- [Template name](https://www.nuget.org/packages/**packageName**/) - ![GitHub stars](https://img.shields.io/github/stars/**org**/**repo**?style=flat-square&cacheSeconds=604800&logo=microsoft) ![last commit](https://img.shields.io/github/last-commit/**org**/**repo**?style=flat-square&cacheSeconds=86400) Short description of the template.
+-->