#41 Update mailing list subscription recommendations
Merged 2 years ago by oturpe. Opened 2 years ago by oturpe.
fedora-docs/ oturpe/package-maintainer-docs share-mailing-list-list  into  main

@@ -58,26 +58,9 @@ 

  [#join_the_important_mailing_lists]

  === Join the important Mailing Lists

  

- You should join the Fedora https://lists.fedoraproject.org/admin/lists/devel-announce@lists.fedoraproject.org/[devel-announce] mailing list.

- It is a low traffic announcements only list,

- where important development information is posted.

- 

- You should join the Fedora https://lists.fedoraproject.org/admin/lists/devel@lists.fedoraproject.org/[devel] mailing list,

- where discussions about the development of Fedora are held.

- This is a high traffic mailing list.

- 

- You should also consider joining the https://lists.fedoraproject.org/admin/lists/package-announce@lists.fedoraproject.org/[package-announce] mailing list

- -- The commits mailing list gets notifications

- on all commits in any package

- in the Fedora repository.

- This is a very high traffic mailing list.

- The Fedora package database sends commit mails for packages you (co-)maintain.

- 

- Another mailing list you might consider

- (at least to view the archives)

- is https://lists.fedoraproject.org/admin/lists/packaging@lists.fedoraproject.org/[packaging].

- This is the mailing list of the https://fedoraproject.org/wiki/Packaging_Committee[Fedora Packaging Committee],

- who determine the official packaging guidelines for Fedora projects.

+ Consider joining the following mailing lists:

+ 

+ include::{partialsdir}/mailing_lists.adoc[]

  

  [#introduce_yourself]

  === Introduce yourself
@@ -113,23 +96,6 @@ 

  that goes on in any of the lists.

  Community discussion and feedback is always encouraged.

  

- [#find_software_you_wish_to_packagemaintain_for_fedora]

- === Find software you wish to package/maintain for Fedora

- 

- The package you are submitting can be of any Free and Open Source project

- that is not already packaged in Fedora.

- Before creating your package,

- make sure that the software is not already in the Fedora repository,

- or waiting for review.

- 

- * Search the https://src.fedoraproject.org/[Fedora packages] for packages already in the repository.

- 

- * Search in the http://fedoraproject.org/PackageReviewStatus/[Review Tracker] for packages under review.

- 

- * Also check the https://packager-dashboard.fedoraproject.org/user/orphan[orphaned or retired packages that need new maintainers].

- 

- * Be aware of https://fedoraproject.org/wiki/Forbidden_items[forbidden items].

- 

  [#understand_your_responsibilities]

  === Understand your responsibilities

  
@@ -150,7 +116,8 @@ 

  to learn about packaging

  and gain familiarity with the process and requirements.

  

- One way of doing this is to join the mailing list.

+ One way of doing this is to join the

+ https://lists.fedoraproject.org/archives/list/package-review@lists.fedoraproject.org/[package-review mailing list].

  All comments on Fedora package reviews are sent to this

  (read-only from your point of view)

  list.
@@ -248,10 +215,44 @@ 

  

  xref:Using_the_Koji_Build_System.adoc[Using the Koji build system] has more information about using Koji.

  

- [#adding_a_new_package]

- == Adding a new package

+ [#find_software]

+ == Finding software you wish to maintain for Fedora

+ 

+ Being a Fedora packager means doing package maintenance.

+ To ge started, you need to find some packages maintain.

+ 

+ [#find_software_existing]

+ === Existing software

+ 

+ Even packages that already exist in Fedora

+ need regular maintenance.

+ The Fedora version may be behind the latest upstream release,

+ there may be bugs to be fixed

+ upstream or in the packaging scripts,

+ the packaging scripts can be improved even in the resulting package already works

+ and so on.

+ 

+ To get involved in the maintenance of some packages,

+ you should know what is going on with them.

+ Subscribe to notifications about packages you consider interesting

+ by adjusting the _Watch_ setting for them

+ in the https://src.fedoraproject.org[Package Sources].

+ 

+ There are also mailing lists for notifications about activity in any package.

+ Note that the volume of these mailing lists is very high.

+ Most probably they are only useful as input for automatic processing:

+ 

+ * https://lists.fedoraproject.org/archives/list/scm-commits@lists.fedoraproject.org/[scm-commits]

+ has all commits to all package repositories.

+ 

+ * https://lists.fedoraproject.org/archives/list/package-announce@lists.fedoraproject.org/[package-announce]

+ has all stable updates.

+ 

+ [#find_software_new]

+ === New software

  

- Follow xref:New_Package_Process_for_New_Contributors.adoc[New Package Process for New Contributors].

+ If you intend to add a new package to Fedora,

+ follow xref:New_Package_Process_for_New_Contributors.adoc[New Package Process for New Contributors].

  

  [#getting_help]

  == Getting Help

@@ -7,6 +7,26 @@ 

  containing more details so new contributors can follow it more easily.

  Also the mandatory xref:How_to_Get_Sponsored_into_the_Packager_Group.adoc[sponsoring] step is included.

  

+ [#check]

+ == Check if the package already exists

+ 

+ If some useful software is not included in Fedora already,

+ you can submit it as a new package.

+ The package you are submitting can be of any Free and Open Source project.

+ 

+ Before creating your package,

+ make sure that the software is not already in the Fedora repository:

+ 

+ * Check if the package already exists by searching in

+ https://packages.fedoraproject.org/[Fedora Packages].

+ 

+ * Search in the http://fedoraproject.org/PackageReviewStatus/[Review Tracker]

+ for packages under review.

+ 

+ * Check the https://packager-dashboard.fedoraproject.org/user/orphan[orphaned or retired packages that need new maintainers].

+ 

+ * Be aware of https://fedoraproject.org/wiki/Forbidden_items[forbidden items].

+ 

  [#make_a_package]

  == Make a Package

  

file modified
+1 -14
@@ -71,20 +71,7 @@ 

  [#important_mailing_lists]

  === Important Mailing Lists

  

- * https://lists.fedoraproject.org/admin/lists/devel-announce@lists.fedoraproject.org/[devel-announce] is a low traffic, announcements only list

- where important development information is posted.

- 

- * https://lists.fedoraproject.org/admin/lists/devel@lists.fedoraproject.org/[devel] is a high traffic mailing list

- where discussions about the development of Fedora are held.

- 

- * https://lists.fedoraproject.org/admin/lists/package-announce@lists.fedoraproject.org/[package-announce] is a very high traffic mailing list

- where notifications are given for all the commits

- in any package in the Fedora repository.

- Note that the Fedora package database sends commit mails

- for packages you (co-)maintain.

- 

- * https://lists.fedoraproject.org/admin/lists/packaging@lists.fedoraproject.org/[packaging] is the mailing list of the https://fedoraproject.org/wiki/Packaging_Committee[Fedora Packaging Committee],

- who determine the official packaging guidelines for Fedora projects.

+ include::{partialsdir}/mailing_lists.adoc[]

  

  * https://listman.redhat.com/mailman/listinfo/bugzilla-announce-list[bugzilla-announce-list] is where announcements about https://bugzilla.redhat.com[Red Hat Bugzilla] are shared.

  

@@ -0,0 +1,12 @@ 

+ * https://lists.fedoraproject.org/admin/lists/devel-announce@lists.fedoraproject.org/[devel-announce]

+ is a low traffic, announcements only list

+ where important development information is posted.

+ 

+ * https://lists.fedoraproject.org/admin/lists/devel@lists.fedoraproject.org/[devel]

+ is a high traffic mailing list

+ where discussions about the development of Fedora are held.

+ 

+ * https://lists.fedoraproject.org/admin/lists/packaging@lists.fedoraproject.org/[packaging]

+ is the mailing list of the

+ https://fedoraproject.org/wiki/Packaging_Committee[Fedora Packaging Committee],

+ who determine the official packaging guidelines for Fedora projects.

Is the package-review list worth mentioning as a high traffic list where are package review related e-mails are sent?

package-review@lists.fedoraproject.org

Page Joining the Package Maintainers suggested
subscribing to the package-announce mailing list.
Due to its great volume,
this is not generally a good idea.
Replaced that suggestion with a suggestion
to adjust the Watch settings in the Package Sources.
Package-announce, as well as similar scm-commits list,
are mentioned as an alternative.

Finding a section where this information can be located
required some changes in document structure,
which as an additional improvement
also allows giving a bit more visibility
for the fact that a productive Package Maintainer
does not necessarily have to own a package.

rebased onto 79b20bb44fa68ede557806917005e0ad8802db48

2 years ago

rebased onto 6763887e146144640a1eca0720866985fa003cf5

2 years ago

Should we also suggest the packages app? (the search function on src.fp.o is not very nice)

https://packages.fedoraproject.org/ ?

This is about co-maintaining? Should we put this at the end near the "adding a new package" bit as one of the two paths to being a maintainer?

Is the package-review list worth mentioning as a high traffic list where are package review related e-mails are sent?

package-review@lists.fedoraproject.org

Looks good in general, a few comments but nothing major :)

Metadata Update from @ankursinha:
- Request assigned

2 years ago

Should we also suggest the packages app? (the search function on src.fp.o is not very nice)
https://packages.fedoraproject.org/ ?

Good idea, I will add that.

This is about co-maintaining? Should we put this at the end near the "adding a new package" bit as one of the two paths to being a maintainer?

Yes, either co-maintaining or even more informal contribution
in form of bug reports, pull requests and taking part in discussion.
The main idea is that there is much more to packaging
than just having your own package.
Ideally, making changes related to that should be done separately,
not mixed in a pull request about mailing lists.
But I was not happy at all about having scm-commits and package-announce
in the list of "important mailing lists",
as if you could usefully subscribe to those without having automatic processing.
The volume is simply too great.
But on the devel list, an opinion was expressed
that these lists should be mentioned somehow,
so I did some restructuring to find a place to mention them
in a sensible context.

You are right that the fallout from this,
i.e. having co-maintainer related things in one place
and new packages at another
is also strange.
I will see what can be done.

Is the package-review list worth mentioning as a high traffic list where are package review related e-mails are sent?
package-review@lists.fedoraproject.org

Well, since scm-commits and package-announce are mentioned,
it would be weird not to mention this.
On the other hand,
I think the list of important mailing lists should be such
that the newcomer can simply subscribe to all of them.
Making them think which lists are useful and which not is more mental burden,
and there is enough of that in the Joining phase already.

I think a good place to mention this list could be section Read Other Submissions.
Actually, it probably is trying to recommend it,
but somehow list name and a link to its Hyperkitty page is missing.
Maybe due to an error in the wiki import,
Pandoc helpfully replaces some Wiki markup it does not understand with empty strings,
causing issues that look exactly like that.
What if I just insert the list there?

rebased onto eb5fd87

2 years ago

Pull-Request has been merged by oturpe

2 years ago

I did the changes as discussed.
I think there is no need for another round of review here,
so I went ahead and merged the updated version.
If there are any concerns about the updated version,
we can always push fixes later.

Thank you for the review!