Refine the awesome list guidelines and the pull request guidelines.

This commit is contained in:
Yedda Wang
2024-02-27 15:14:26 +08:00
parent 8fecd0eaad
commit 1a9cc6bef9
2 changed files with 154 additions and 109 deletions

View File

@@ -4,28 +4,26 @@
Congratulations on creating an Awesome list! 🎉
> [!NOTE]
> Make sure your list is compliant with the [list guidelines](list-guidelines.md), before you send a pull request to the [Awesome](repo) list.
> Make sure that your list is compliant with the [list guidelines](list-guidelines.md), before you send a pull request to the [Awesome](repo) list.
> [!NOTE]
> Make sure you have put your best effort to your list. Otherwise, your pull request will be immediately closed.
> Make sure that you have put your best effort to your list. Otherwise, your pull request will be immediately closed.
---
<!-- omit from toc -->
## Contents
- [Add your list to Awesome](#add-your-list-to-awesome)
- [Create a pull request](#create-a-pull-request)
- [Add your list to Awesome](#add-your-list-to-awesome)
- [Create a pull request](#create-a-pull-request-1)
- [Pull request title](#pull-request-title)
- [Pull request template](#pull-request-template)
- [Homework](#homework)
- [Pull request template](#pull-request-template)
- [Submit your pull request](#submit-your-pull-request)
---
## Create a pull request
### Add your list to [Awesome][repo]
## Add your list to [Awesome][repo]
> [!TIP]
> If you don't know how to edit contents on Github, refer to [Contribution Guidelines](contributing.md#adding-something-to-an-awesome-list).
@@ -36,54 +34,69 @@ Follow these steps to add your list to the [Awesome][repo] list:
2. Write your list title in title case.
3. Link your list title to its repository by a URL ending with `#readme`.
4. Write a short description for your list.
- Descripe the content in your list objectively in the short description, instead of the list itself.
- Do not use a tagline or marketing blurb as the short description.
- Do not contain the list title in the short description.
- The first character of the short description must be uppercase.
- The short description must end with a period.
5. Separate the list title and the short description with a dash.
> [!NOTE]
> Descripe the content in your list objectively in the short description, instead of the list itself.
>
> Do not use a tagline or marketing blurb as the short description.
>
> Do not contain the list title in the short description.
>
> The first character of the short description must be uppercase.
>
> The short description must end with a period.
Exmaples of items in the [Awesome][repo] list:
Exmaples:
`- [iOS](…) - Mobile operating system for Apple phones and tablets.`
`- [Framer](…) - Prototyping interactive UI designs.`
`- [iOS](…) - Resources and tools for iOS development.`
`- [Framer](…)`
`- [Framer](…) - prototyping interactive UI designs`
- `- [iOS](…) - Mobile operating system for Apple phones and tablets.`
- `- [Framer](…) - Prototyping interactive UI designs.`
- `- [iOS](…) - Resources and tools for iOS development.`
- `- [Framer](…)`
- `- [Framer](…) - prototyping interactive UI designs`
Source code example of an item in the [Awesome][repo] list:
Source code example:
```Markdown
```markdown
- [Software Architecture](https://github.com/simskij/awesome-software-architecture#readme) - The discipline of designing and building software.
```
### Create a pull request
## Create a pull request
> [!NOTE]
> Do not submit a pull request in draft status. If you want to get feedback from people, make a comment on [Issue #2242][incubating lists]. Refer to the [list guidelines](list-guidelines.md) for more details.
> Do not submit a pull request in draft status. If you want to get feedback from people, make a comment on [Issue #2242][incubating lists]. Refer to the [awesome list guidelines](list-guidelines.md) for more details.
1. Create a new [pull request] with a title in the format of `Add Name of List`.
2. Descripe your list according to the [pull request template](#pull-request-template) below.
### Pull request title
> [!NOTE]
> Do not include the word `Awesome` in an issue title.
> Do not include the word `Awesome` in the pull request title.
Examples of issue titles:
Type a [pull request] title in following format:
`Add Swift`
`Add Software Architecture`
`Update readme.md`
`Add Awesome Swift`
`Add swift`
`add Swift`
`Adding Swift`
`Added Swift`
```
Add Name of List
```
Examples:
- `Add Swift`
- `Add Software Architecture`
-`Update readme.md`
-`Add Awesome Swift`
-`Add swift`
-`add Swift`
-`Adding Swift`
-`Added Swift`
### Pull request template
[Insert the URL of your list here]
[Explain what your list is about and why it should be included here]
[Insert the pull requests you reviewed in [Homework](#homework) here]
[Type the secret word hidden in the list guidelines and the pull request guidelines]
> [!IMPORTANT]
> By submitting this pull request, I confirm I've read and complied with the list guidelines and the pull request guidelines for awesome lists. 🖖
## Homework
@@ -104,19 +117,6 @@ Review at least two other [pull request]s before you open a pull request to add
> [!TIP]
> Look at previous pull request reviews for inspiration.
## Pull request template
[Insert the URL of your list here]
[Explain what your list is about and why it should be included here]
[Insert the pull requests you reviewed here]
[Type the secret word hidden in the list guidelines and the pull request guidelines]
> [!IMPORTANT]
> By submitting this pull request, I confirm I've read and complied with the list guidelines and the pull request guidelines for awesome lists. 🖖
## Submit your pull request
1. Check your list and your pull request again to make sure they are compliant with the guidelines.