# Pull Request Guidelines Congratulations on creating an Awesome list! 🎉 > [!NOTE] > Make sure that your list is compliant with the [awesome list guidelines](awesome-list-guidelines.md), before you send a pull request to the [Awesome](repo) list. > [!NOTE] > Make sure that you have put your best effort to your list. Otherwise, your pull request will be immediately closed. --- ## Contents - [Add your list to Awesome](#add-your-list-to-awesome) - [Create a pull request](#create-a-pull-request) - [Pull request title](#pull-request-title) - [Pull request description template](#pull-request-description-template) - [Homework](#homework) - [Submit your pull request](#submit-your-pull-request) --- ## 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). Follow these steps to add your list to the [Awesome][repo] list: 1. Add a new item to the bottom of the category that your list belongs to. 2. Type 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. 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` Source code example: ```markdown - [Software Architecture](https://github.com/simskij/awesome-software-architecture#readme) - The discipline of designing and building software. ``` ## 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 [awesome list guidelines](list-guidelines.md) for more details. ### Pull request title > [!NOTE] > Do not include the word `Awesome` in the pull request title. Type a [pull request] title in following format: ``` 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 description 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] > [!IMPORTANT] > By submitting this pull request, I confirm I've read and complied with the awesome list guidelines and the pull request guidelines for awesome lists. 🖖 ## Homework In order to help the [Awesome][repo] list self-sustaining, please complete the homework before you submit the pull request: Review at least two other [pull request]s before you open a pull request to add your list in the [Awesome][repo] list. You can make comments at the following aspects: - Prioritize unreviewed pull requests. - Make comments on reviewed pull requests. > [!NOTE] > You must point out mistakes or improvement suggestions in your comments. > > A comment like "looks good" or "approved" does not count. > > A comment on lint violation is allowed, but it does not count as a review. > [!TIP] > Look at previous pull request reviews for inspiration. ## Submit your pull request 1. Check your list and your pull request again to make sure they are compliant with the guidelines. 2. Submit your pull request. [repo]: https://github.com/sindresorhus/awesome [incubating lists]: https://github.com/sindresorhus/awesome/issues/2242 [pull request]: https://github.com/sindresorhus/awesome/pulls?q=is%3Apr+is%3Aopen