diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..9996117 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,29 @@ +# Checklist for Pull Request + +> 🚨Please review the **[guidelines for contributing](../../CONTRIBUTING)** to this repository. + +## 🎉 Instructions for adding a new Project in the Repository + +- [ ] Fork the repository + +- [ ] Create a branch for your addition **(I.e. sunrise-standup)** + +- [ ] Add to the **[README](../../README.md)** + +- [ ] Include a site image following code this sample: + +```html +
+ +
+``` + +- [ ] Follow the examples in the **[README](../../README.md)** for formatting details + +- [ ] Submit your Pull Request + +## ✏️ Description + +Please describe your Pull Request. + +💔Thank you! \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..989cf9f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,13 @@ +# Contributing + +This project welcomes contributions and suggestions. Most contributions require you to agree to a +Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us +the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. + +When you submit a pull request, a CLA bot will automatically determine whether you need to provide +a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions +provided by the bot. You will only need to do this once across all repos using our CLA. + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or +contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. diff --git a/README.md b/README.md index 0eb5ec3..105c763 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,11 @@ A gallery of sample projects in JavaScript/Node.js and frameworks/Jamstack site generators deployed in **[Azure Static Web Apps](https://docs.microsoft.com/azure/static-web-apps/?WT.mc_id=staticwebapps-github-cxa)**. -## Projects 💻 +## 🔥 Submit your Projects + +Would you like to include your project hosted/deployed on **[Azure Static Web Apps](https://docs.microsoft.com/azure/static-web-apps/?WT.mc_id=staticwebapps-github-cxa)** on our gallery of samples? If so, just follow the **[Checklist for Pull Request](./.github/PULL_REQUEST_TEMPLATE/pull_request_template.md)**, which as soon as possible we will include your deployed project in our repository! + +## 💻 Projects - [Angular Projects](#angular-projects) - [Catsify: A cat names generator](#catsify-a-cat-names-generator) @@ -322,17 +326,3 @@ Link to the project: **[HERE]()** > Stacks Used: `vuepress, azure static web apps` --- - -# Contributing - -This project welcomes contributions and suggestions. Most contributions require you to agree to a -Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us -the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. - -When you submit a pull request, a CLA bot will automatically determine whether you need to provide -a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions -provided by the bot. You will only need to do this once across all repos using our CLA. - -This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). -For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or -contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.