Hosted Projects

The following guidelines have been proposed for hosted projects in an attempt to prevent a repeat of the genkernel disaster.

Documentation Requirement

All hosted projects should have decent, up to date user and developer documentation. This documentation must be available before the first release, and not left as "something we'll do later (honest)".

Our documentation team are happy to help out with GuideXMLification, translation etc. for the user documentation, but they need various things to do this:

Developer documentation is generally best left in the hands of the project maintainers.

Portability

Gentoo runs on a large number of architectures. This is one of our big advantages over some other distributions. It is therefore important that any tools are made with portability in mind, even if you originally think that your tool is only relevant for one arch. It was this kind of assumption that meant that genkernel had to be completely rewritten when it suddenly became mandatory.

In practice, this means the following:

Open / Free

All hosted projects should use an appropriate open / free / libre license. Typically this will be the GPL v2 for software, and the Creative Commons license for documentation. However, reasonable exceptions can be made — sometimes it makes more sense to use the LGPL or a *BSD license, and for application-specific projects going with the application's license may make more sense (the gentoo-syntax package for vim uses the vim license, for example).

Accessible

Projects should be accessible to users with disabilities. Simple examples of how to go about this include:

Good places to look for further hints include: