From b07b6d25b3e046bafbbfead2995b5cdb37b78ac7 Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 14 Jul 2021 08:08:24 -0700 Subject: [PATCH 1/4] Remove unnecessary link from submission instructions This link was intended to provide readily accessible information on what the term "fork" means in this context. However, it comes directly after mention a link, which is referencing the URL provided later in the sentence. This might result in confusion about which of the two links is meant. Most library submitters will already know the meaning of the term "fork" and those who don't will be able to find information about it easily enough, including by visiting the information about pull requests linked to earlier in the document. So I think that it's better to remove this link. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 356c6c10..80e6b595 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ See the instructions below for detailed instructions on how to do this via the G 1. You may want to first take a look at [the requirements for admission into the Arduino Library Manager index](FAQ.md#submission-requirements). Each submission will be checked for compliance before being accepted. -1. Open this link to [fork](https://guides.github.com/activities/forking/) this repository and edit the list via the +1. Open this link to fork this repository and edit the list via the GitHub web interface: https://github.com/arduino/library-registry/edit/main/repositories.txt 1. Add the library repository's URL to the list. This should be the URL of the repository home page. For example: `https://github.com/arduino-libraries/Servo`. From a713efe27d051a432d06e7262e403ea27ac2ef26 Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 14 Jul 2021 08:15:02 -0700 Subject: [PATCH 2/4] Explain that it doesn't matter where in the submission list the URL is added The process is intended to be as simple, fast, and flexible as possible for the submitter. For this reason, there is absolutely no expectation regarding where in `repositories.txt` the library repository URL should be added. The system will work fine no matter if it's at the start, end, alphabetical order, or some random spot. If we do want to restore alphabetical order periodically, a maintainer can easily do that. For this reason, there was previously no mention of the proper location in the list for submitters to use, since there is none. However, this ambiguity might actually make the process less friendly to those who are left wondering. So it's best to explicitly state that the location doesn't matter. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 80e6b595..47d8e584 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ See the instructions below for detailed instructions on how to do this via the G compliance before being accepted. 1. Open this link to fork this repository and edit the list via the GitHub web interface: https://github.com/arduino/library-registry/edit/main/repositories.txt -1. Add the library repository's URL to the list. This should be the URL of the repository home page. For example: +1. Add the library repository's URL to the list (it doesn't matter where in the list). This should be the URL of the repository home page. For example: `https://github.com/arduino-libraries/Servo`. 1. Click the Propose changes button. 1. In the **"Open a pull request"** window that opens, click the Create pull request button. From cd4e15e81373d0a5285b26218ec9169322e9459d Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 14 Jul 2021 08:20:52 -0700 Subject: [PATCH 3/4] Add missing steps to submission instructions It turns out there are a couple of extra steps in the workflow for submitting a PR via the GitHub web interface for those who don't have write access in the repository. I missed these while developing the instructions due to having write access. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 47d8e584..3f09296e 100644 --- a/README.md +++ b/README.md @@ -37,9 +37,11 @@ See the instructions below for detailed instructions on how to do this via the G compliance before being accepted. 1. Open this link to fork this repository and edit the list via the GitHub web interface: https://github.com/arduino/library-registry/edit/main/repositories.txt +1. Click the Fork this repository button. 1. Add the library repository's URL to the list (it doesn't matter where in the list). This should be the URL of the repository home page. For example: `https://github.com/arduino-libraries/Servo`. 1. Click the Propose changes button. +1. In the **"Comparing changes"** window that opens, click the Create pull request button. 1. In the **"Open a pull request"** window that opens, click the Create pull request button. The library will be automatically checked for compliance as soon as the pull request is submitted. If no problems were From faa42b3076c892479afc9fb749be4597ceda6b33 Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 14 Jul 2021 08:23:08 -0700 Subject: [PATCH 4/4] Remove potentially confusing punctuation from submission instructions The period to close the sentence might be interpreted as part of the example repository URL. Since it doesn't provide any benefits for the readability of this sentence and might cause confusion, it's best to remove it. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3f09296e..af64c1c1 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ See the instructions below for detailed instructions on how to do this via the G GitHub web interface: https://github.com/arduino/library-registry/edit/main/repositories.txt 1. Click the Fork this repository button. 1. Add the library repository's URL to the list (it doesn't matter where in the list). This should be the URL of the repository home page. For example: - `https://github.com/arduino-libraries/Servo`. + `https://github.com/arduino-libraries/Servo` 1. Click the Propose changes button. 1. In the **"Comparing changes"** window that opens, click the Create pull request button. 1. In the **"Open a pull request"** window that opens, click the Create pull request button.