Differences between revisions 49 and 51 (spanning 2 versions)
Revision 49 as of 2016-03-04 12:06:47
Size: 2681
Comment: Switch to cgit and https for team package list url
Revision 51 as of 2016-06-07 18:24:12
Size: 5957
Editor: Balasankar C
Comment:
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
= About the Ruby team = = General Information =
Line 8: Line 8:
 * The interpreter packages are maintained inside of the [[https://alioth.debian.org/projects/collab-maint/|collab-maint project]].
* [[/Jessie|Goals for Debian Jessie]]
 * The interpreter packages are maintained inside of the [[https://alioth.debian.org/projects/collab-maint/|collab-maint project]].
Line 11: Line 10:
= Get in touch = The complete information is spread across this page and the following pages:
[[/Packaging]] [[/Packaging/Conventions]] [[/Packaging/TestFailures]] [[/Packaging/Tests ]]
Line 13: Line 13:
Mailing lists: == Packages information ==
 * [[http://qa.debian.org/developer.php?login=pkg-ruby-extras-maintainers%40lists.alioth.debian.org&comaint=yes|Packages overview]]
 * [[http://pet.debian.net/pkg-ruby-extras/pet.cgi|PET overview for packages in Git]]
 * [[http://udd.debian.org/dmd.cgi?email1=pkg-ruby-extras-maintainers%40lists.alioth.debian.org|Debian Maintainer Dashboard for the team]]
 * [[http://anonscm.debian.org/gitweb/?pf=pkg-ruby-extras|list of all Git repositories owned by the pkg-ruby-extras team]]
Line 15: Line 19:
 * [[http://lists.debian.org/debian-ruby/|debian-ruby mailing list]] -- General discussions, sponsorship requests etc
 * [[http://lists.alioth.debian.org/mailman/listinfo/pkg-ruby-extras-maintainers|pkg-ruby-extras-maintainers mailing list]] -- bug reports and other communication targetted at team-maintained packages
= Joining Debian Ruby Extras Maintainers =
Line 18: Line 21:
IRC: `#debian-ruby` channel on `irc.debian.org` Debian Ruby team does its activities under the alioth group which contains repositories where the team maintained packages are version controlled, mailing lists where discussions take place etc.
Line 20: Line 23:
= How to contribute = == Communication ==
=== Mailing List ===
The general discussion mailing list of Debian Ruby team can be found at https://lists.debian.org/debian-ruby/ . The mailing list is open for anybody to join and post and acts as the central point of access for communication with the Team. To post to the mailing list, send a mail to debian-ruby@lists.debian.org
Line 22: Line 27:
We are currently working on [[/Jessie|several items for the next Debian release]]. There are several items there in need of a volunteer to do it. Feel free to mail the [[http://lists.debian.org/debian-ruby/|team mailing list]] if you need any clarification before contributing to one of those items. === IRC ===
Debian Ruby team maintains the IRC channel [[http://webchat.oftc.net/?channels=debian-ruby|#debian-ruby]] in the OFTC server where team members hang around. This channel acts as a quick way to communicate with the team and is used heavily during sprints, online meetings etc.
Line 24: Line 30:
Besides that, there are recurring tasks that can always benefit from more people helping: == Alioth ==
The team's alioth group can be found here - https://alioth.debian.org/projects/pkg-ruby-extras/ . To maintain the packages under Debian Ruby team, it is preferred to join the team and version control the packages under the git repos available. Steps for joining alioth group are
Line 26: Line 33:
 * Improving documentation (this page, the [[Ruby]] page, etc..)
 * Maintainance of the [[http://qa.debian.org/developer.php?login=pkg-ruby-extras-maintainers%40lists.alioth.debian.org&comaint=yes|team packages]], including:
   * bug triaging
   * bug fixing
   * packaging improvements in general
 1. Create an account in alioth - https://alioth.debian.org/account/register.php
 2. Upload your SSH key to alioth - https://alioth.debian.org/account/editsshkeys.php
    i. To know about creating an SSH key, visit https://wiki.debian.org/Alioth/SSH
 3. Request to join the Debian Ruby team - https://alioth.debian.org/project/request.php?group_id=30665
 4. Wait for a group admin to add you to the group.
 5. To speed up the procedure, send an email to the mailing list (debian-ruby@lists.debian.org) stating your request to join the alioth group and preferably the package you intend to maintain under the team.
Line 32: Line 40:
= Documentation and Links =
Line 34: Line 41:
 * Packaging basics: see the `packaging-tutorial` package
   * `$ apt-get install packaging-tutorial`
   * '''[[/Packaging|Team Documentation and current packaging practices]]'''.
= Contributing to Debian Ruby Extras Maintainers Team =

If you are a Debian enthusiast with basic Ruby knowledge, you can help Debian Ruby Extras Team's activities. There are different ways to contribute to Debian Ruby Team, which includes (and is not limited to)

== Identifying and reporting bugs ==


If you are a user of the packages maintained by Debian Ruby team, you can help us by reporting the bugs you find in the packages using the [[http://bugs.debian.org|Debian Bug Tracker]] or [[https://wiki.debian.org/reportbug|reportbug]] tool. You can also add wishlist bugs about changes/features you would like to be added to the package so as to make it better to use.

== Bug triaging ==

You can also help to triage bugs, by choosing bugs from https://bugs.debian.org/pkg-ruby-extras-maintainers@lists.alioth.debian.org or https://udd.debian.org/dmd/?email1=pkg-ruby-extras-maintainers%40lists.alioth.debian.org&email2=&email3=&packages=&ignpackages=&format=html#todo, and try to
 1. reproduce them on your local machine / clean chroot as needed
 2. confirm bug's existence and validity
 3. Tag bugs appropriately
 4. Close invalid ones

== Fixing bugs ==

If you have knowledge in Ruby, you can fix bugs that have been filed against the team maintained packages by providing patches and helpful information. Those like FTBFS bugs are often caused by test failures in packages and should be fixed to ensure reproducibility of the packages.

Chances of bugs are more during transition of the Ruby version and any help in identifying, tagging and fixing them are much appreciated.

== Documentation ==

This wiki, and it's subpages are intended to collect all the information regarding the structure, activities and conventions of Debian Ruby team, and needs extensive care and help to be maintained in good, up-to-date state. Start by [[https://wiki.debian.org/FrontPage?action=newaccount|creating an account]] in Debian Wiki and cleaning up the pages to contain only valid, prompt and updated information

== Packaging ==

'''Workflow about packaging new Ruby based software for Debian can be found [[/Packaging|here]].'''

== Maintaining ==

Maintainance of a package involves the tasks like updating a package to the latest version, keeping the package to be in accordance with the current Debian policies and standards etc. To know about updating a package and uploading it, visit here.

= Miscellaneous Documentation =
 * [[/InterpreterTransitions | Interpreter Transition Mechanism]] - Steps to follow on updating the version of Ruby interpreters in Debian archives.
 * [[http://pkg-ruby-extras.alioth.debian.org/wheezy/|Current status]] of the gem2deb transition
 * '''[[/Packaging|Team Documentation and current packaging practices]]'''.
Line 38: Line 81:
 * overview of team packages
   * [[http://qa.debian.org/developer.php?login=pkg-ruby-extras-maintainers%40lists.alioth.debian.org&comaint=yes|Packages overview]]
   * [[http://pet.debian.net/pkg-ruby-extras/pet.cgi|PET overview for packages in Git]]
   * [[http://udd.debian.org/dmd.cgi?email1=pkg-ruby-extras-maintainers%40lists.alioth.debian.org|Debian Maintainer Dashboard for the team]]
   * [[https://anonscm.debian.org/cgit/pkg-ruby-extras/|list of all Git repositories owned by the pkg-ruby-extras team]]
Line 44: Line 82:
 * [[http://pkg-ruby-extras.alioth.debian.org/wheezy/|Current status]] of the gem2deb transition
 * [[/Ruby2.2|Ruby 2.2 Transition Help]]
 * [[/InterpreterTransitions]] mechanism
 * [[/Rails4.2|Rails 4.2 update]]
= Sub Pages =
Sub pages of this documentation can be found below:
<<Navigation(children,30)>>

General Information

The Debian Ruby team maintains Ruby software in Debian. This includes the interpreters, libraries and applications.

The complete information is spread across this page and the following pages: /Packaging /Packaging/Conventions ?/Packaging/TestFailures /Packaging/Tests

Packages information

Joining Debian Ruby Extras Maintainers

Debian Ruby team does its activities under the alioth group which contains repositories where the team maintained packages are version controlled, mailing lists where discussions take place etc.

Communication

Mailing List

The general discussion mailing list of Debian Ruby team can be found at https://lists.debian.org/debian-ruby/ . The mailing list is open for anybody to join and post and acts as the central point of access for communication with the Team. To post to the mailing list, send a mail to debian-ruby@lists.debian.org

IRC

Debian Ruby team maintains the IRC channel #debian-ruby in the OFTC server where team members hang around. This channel acts as a quick way to communicate with the team and is used heavily during sprints, online meetings etc.

Alioth

The team's alioth group can be found here - https://alioth.debian.org/projects/pkg-ruby-extras/ . To maintain the packages under Debian Ruby team, it is preferred to join the team and version control the packages under the git repos available. Steps for joining alioth group are

  1. Create an account in alioth - https://alioth.debian.org/account/register.php

  2. Upload your SSH key to alioth - https://alioth.debian.org/account/editsshkeys.php

    1. To know about creating an SSH key, visit https://wiki.debian.org/Alioth/SSH

  3. Request to join the Debian Ruby team - https://alioth.debian.org/project/request.php?group_id=30665

  4. Wait for a group admin to add you to the group.
  5. To speed up the procedure, send an email to the mailing list (debian-ruby@lists.debian.org) stating your request to join the alioth group and preferably the package you intend to maintain under the team.

Contributing to Debian Ruby Extras Maintainers Team

If you are a Debian enthusiast with basic Ruby knowledge, you can help Debian Ruby Extras Team's activities. There are different ways to contribute to Debian Ruby Team, which includes (and is not limited to)

Identifying and reporting bugs

If you are a user of the packages maintained by Debian Ruby team, you can help us by reporting the bugs you find in the packages using the Debian Bug Tracker or reportbug tool. You can also add wishlist bugs about changes/features you would like to be added to the package so as to make it better to use.

Bug triaging

You can also help to triage bugs, by choosing bugs from https://bugs.debian.org/pkg-ruby-extras-maintainers@lists.alioth.debian.org or https://udd.debian.org/dmd/?email1=pkg-ruby-extras-maintainers%40lists.alioth.debian.org&email2=&email3=&packages=&ignpackages=&format=html#todo, and try to

  1. reproduce them on your local machine / clean chroot as needed
  2. confirm bug's existence and validity
  3. Tag bugs appropriately
  4. Close invalid ones

Fixing bugs

If you have knowledge in Ruby, you can fix bugs that have been filed against the team maintained packages by providing patches and helpful information. Those like FTBFS bugs are often caused by test failures in packages and should be fixed to ensure reproducibility of the packages.

Chances of bugs are more during transition of the Ruby version and any help in identifying, tagging and fixing them are much appreciated.

Documentation

This wiki, and it's subpages are intended to collect all the information regarding the structure, activities and conventions of Debian Ruby team, and needs extensive care and help to be maintained in good, up-to-date state. Start by creating an account in Debian Wiki and cleaning up the pages to contain only valid, prompt and updated information

Packaging

Workflow about packaging new Ruby based software for Debian can be found here.

Maintaining

Maintainance of a package involves the tasks like updating a package to the latest version, keeping the package to be in accordance with the current Debian policies and standards etc. To know about updating a package and uploading it, visit here.

Miscellaneous Documentation

Sub Pages

Sub pages of this documentation can be found below: