Skip to content

Commit 1c73e42

Browse files
authored
README: tweak submission guidelines (#1026)
As we learned recently, the 'manual' submission of packages via a self-created PRs is not optimally supported and lacks some features, so let's not advertise it anymore. Also clarify some other points.
1 parent f855be3 commit 1c73e42

File tree

1 file changed

+3
-9
lines changed

1 file changed

+3
-9
lines changed

README.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ to go about this that ensure we will still be able to pick up updates:
4545

4646
There are several options how to do this.
4747

48-
1. Submit an issue to this repository, requesting that your package be added.
48+
1. (**RECOMMENDED**) Submit an issue to this repository, requesting that your package be added.
4949
Make sure to include a link to the `PackageInfo.g` file of your package.
5050
Note that such requests are visible to the anyone watching this repository.
5151

@@ -54,11 +54,6 @@ There are several options how to do this.
5454
Note that such requests are visible to only to a small group of people listed
5555
[on this web page](https://www.gap-system.org/Contacts/People/supportgroup.html).
5656

57-
3. Open a pull request to this repository manually: first run the script
58-
`tools/import_packages.py URL_OF_PACKAGEINFO_G` with a list of one or more
59-
URLs of PackageInfo.g files for the packages to be added. The script will
60-
download and parse each of them
61-
6257
In either case, we will evaluate your request and will inform you about the
6358
outcome of that (which may be: accept, accept after modifications, reject).
6459

@@ -79,9 +74,8 @@ as follows:
7974
1. Go to <https://github.com/gap-system/PackageDistro/actions/workflows/scan-for-updates.yml>
8075
2. Click "Run workflow" once to open a popup menu. There is a field there accepting
8176
a space separated list of `PackageInfo.g` URLs. Do so.
82-
3. Click on the new green "Run workflow" button to actually trigger the workflow
83-
4. You can now follow this action, it should only run for about 5 minutes, and will
84-
create a new pull request for each package you listed.
77+
3. Click on the new green "Run workflow" button to actually trigger the workflow.
78+
4. After 2-3 minutes this should create a new pull request for each package you listed.
8579

8680
Once the PR is created, a bunch of CI tests are started. Once they are completed,
8781
a report is added to the PR which indicates whether the new package breaks something

0 commit comments

Comments
 (0)