This commit is contained in:
Wassim Chegham 2020-05-21 09:47:32 +02:00 коммит произвёл GitHub
Родитель 8111bfe757
Коммит 3846a8356d
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 44 добавлений и 45 удалений

Просмотреть файл

@ -1,55 +1,54 @@
# Checklist for Pull Request
# Pull Request Checklist
> 🚨Please review the **[guidelines for contributing](../../CONTRIBUTING.md)** to this repository.
> 🚨 Please review the **[guidelines for contributing](../../CONTRIBUTING.md)** before contributing to this repository.
## 🎉 Instructions for adding a new Project in the Repository
## 🎉 Instructions for adding a new Project
- [ ] Fork the repository
- [ ] Create a branch for your addition **(I.e. sunrise-standup)**
- [ ] Add to the **[README](../../README.md)**
- [ ] Include a site image following this code sample:
```html
<p align="center">
<img src="./media/your-app.png" alt="Your App" width="100%">
</p>
```
>
- [ ] Follow the examples in the **[README](../../README.md)** for formatting details. If you're including a new stack not listed, please follow these steps:
1. In the **Project** section include the new stack and the application name:
1. Fork the repository
1. Create a branch for your addition **(for instance, {account}-sunrise-standup)**
1. Include a screenshot of your app in the `./media/` folder
1. Include the app information (use the following code snippet as a template):
```md
- [Gatsby Projects](#gatsby-projects)
### [My Cool App](https://example.com)
<p align="center">
<img src="./media/your-app.png" alt="My Cool App" width="100%">
</p>
<a short description of the app>
- Link to the project: **[HERE](https://example.com)**
- GitHub repo: **[HERE](https://github.com/microsoft)**
> Stacks Used: `gatsby, nodejs, azure static web apps`
> Author Twitter (optional): [@name](https://twitter.com/@name)
```
### Add a new technology (optional)
If you are including a new technology not listed in the README, please follow these steps:
1. Under the **Projects** section, update the table of content and include the new technology.
1. **Make you respect the alphabetical order**
1. Add your application name as a sub-list.
1. **Make sure you use the same acnhors that point to the app information (see blow)**
```md
- [Gatsby](#gatsby)
- [Gatsby Todo App](#gatsby-todo-app)
```
2. Now include all the informations as you can see below (i.e):
## Checklist
```md
## Gatsby Projects
- [ ] update table of content
- [ ] add media file to `./media/`
- [ ] add app name and link
- [ ] add app description
- [ ] add used tech stack
- [ ] add URL to app to the app on Azure Static Web Apps
- [ ] add URL to app repository
- [ ] add author twitter handle (optional)
### Gatsby Website
<include a image>
<a little description about the project.>
- Link to the project: **[HERE]()**
- GitHub repo: **[HERE]()**
> Stacks Used: `gatsby, nodejs, azure static web apps`
```
- [ ] Submit your Pull Request
## ✏️ Description
Please describe your Pull Request.
❤️ Thank you!
❤️ Thank you for your contributions!