From 8e71414aea13959f183b193f0bb62b1034c44fb4 Mon Sep 17 00:00:00 2001 From: S A G A R <110724849+tmsagarofficial@users.noreply.github.com> Date: Thu, 26 Oct 2023 20:29:56 +0530 Subject: [PATCH] Fix typos (#2835) --- awesome.md | 4 ++-- code-of-conduct.md | 4 ++-- contributing.md | 4 ++-- pull_request_template.md | 6 +++--- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/awesome.md b/awesome.md index 1bae22f..4c92438 100644 --- a/awesome.md +++ b/awesome.md @@ -24,7 +24,7 @@ Add an awesome badge to the top of your list, right next to the title. [Example] [![Awesome](https://awesome.re/badge-flat2.svg)](https://awesome.re) ``` -You are allowed to use the badge on lists not included here and also private lists. +You are allowed to use the badge on lists not included here and also on private lists. *The badges should not be modified in any way.* @@ -82,4 +82,4 @@ Create a [table of contents](https://github.com/sindresorhus/stuff/blob/main/toc ## Accept other people's opinion -If you're an owner of the list, respect other people's opinion. If there are plenty of users not agreeing to your decision, give it a second thought. +If you're an owner of the list, respect other people's opinions. If there are plenty of users not agreeing with your decision, give it a second thought. diff --git a/code-of-conduct.md b/code-of-conduct.md index 942d516..506ad0c 100644 --- a/code-of-conduct.md +++ b/code-of-conduct.md @@ -26,9 +26,9 @@ Examples of unacceptable behavior by participants include: advances * Trolling, insulting/derogatory comments, and personal or political attacks * Public or private harassment -* Publishing others' private information, such as a physical or electronic +* Publishing others' private information, such as physical or electronic address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a +* Other conduct that could reasonably be considered inappropriate in a professional setting ## Our Responsibilities diff --git a/contributing.md b/contributing.md index c6935db..a40af0e 100644 --- a/contributing.md +++ b/contributing.md @@ -19,7 +19,7 @@ You'll need a [GitHub account](https://github.com/join)! 1. Access the awesome list's GitHub page. For example: https://github.com/sindresorhus/awesome 2. Click on the `readme.md` file: ![Step 2 Click on Readme.md](https://cloud.githubusercontent.com/assets/170270/9402920/53a7e3ea-480c-11e5-9d81-aecf64be55eb.png) 3. Now click on the edit icon. ![Step 3 - Click on Edit](https://cloud.githubusercontent.com/assets/170270/9402927/6506af22-480c-11e5-8c18-7ea823530099.png) -4. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). ![Step 4 - Edit the file](https://cloud.githubusercontent.com/assets/170270/9402932/7301c3a0-480c-11e5-81f5-7e343b71674f.png) +4. You can start editing the text of the file in the in-browser editor. Make sure you follow the guidelines above. You can use [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). ![Step 4 - Edit the file](https://cloud.githubusercontent.com/assets/170270/9402932/7301c3a0-480c-11e5-81f5-7e343b71674f.png) 5. Say why you're proposing the changes, and then click on "Propose file change". ![Step 5 - Propose Changes](https://cloud.githubusercontent.com/assets/170270/9402937/7dd0652a-480c-11e5-9138-bd14244593d5.png) 6. Submit the [pull request](https://help.github.com/articles/using-pull-requests/)! @@ -27,4 +27,4 @@ You'll need a [GitHub account](https://github.com/join)! Sometimes, a maintainer of an awesome list will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the awesome-* list guidelines. -[Here](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md) is a write up on how to change a Pull Request, and the different ways you can do that. +[Here](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md) is a write up on how to change a Pull Request and the different ways you can do that. diff --git a/pull_request_template.md b/pull_request_template.md index 72dd17d..88c8b04 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -26,7 +26,7 @@ - ❌ `add Swift` - ❌ `Adding Swift` - ❌ `Added Swift` -- [ ] Your entry here should include a short description about the project/theme of the list. **It should not describe the list itself.** The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb. It should not contain the name of the list. +- [ ] Your entry here should include a short description of the project/theme of the list. **It should not describe the list itself.** The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb. It should not contain the name of the list. - ✅ `- [iOS](…) - Mobile operating system for Apple phones and tablets.` - ✅ `- [Framer](…) - Prototyping interactive UI designs.` - ❌ `- [iOS](…) - Resources and tools for iOS development.` @@ -68,7 +68,7 @@ - [ ] Includes a project logo/illustration whenever possible. - Either centered, fullwidth, or placed at the top-right of the readme. [(Example)](https://github.com/sindresorhus/awesome-electron) - The image should link to the project website or any relevant website. - - **The image should be high-DPI.** Set it to maximum half the width of the original image. + - **The image should be high-DPI.** Set it to a maximum of half the width of the original image. - Don't include both a title saying `Awesome X` and a logo with `Awesome X`. You can put the header image in a `#` (Markdown header) or `

`. - [ ] Entries have a description, unless the title is descriptive enough by itself. It rarely is though. - [ ] Includes the [Awesome badge](https://github.com/sindresorhus/awesome/blob/main/awesome.md#awesome-badge). @@ -88,7 +88,7 @@ - **Do not** add the license name, text, or a `Licence` section to the readme. GitHub already shows the license name and link to the full text at the top of the repo. - To verify that you've read all the guidelines, please comment on your pull request with just the word `unicorn`. - [ ] Has [contribution guidelines](https://github.com/sindresorhus/awesome/blob/main/awesome.md#include-contribution-guidelines). - - The file should be named `contributing.md`. Casing is up to you. + - The file should be named `contributing.md`. The casing is up to you. - It can optionally be linked from the readme in a dedicated section titled `Contributing`, positioned at the top or bottom of the main content. - The section should not appear in the Table of Contents. - [ ] All non-important but necessary content (like extra copyright notices, hyperlinks to sources, pointers to expansive content, etc) should be grouped in a `Footnotes` section at the bottom of the readme. The section should not be present in the Table of Contents.