Changes
Page history
Convert all files to CRLF line endings.
authored
Sep 17, 2024
by
Alexandre Julliard
Hide whitespace changes
Inline
Side-by-side
Maintainer-Guidelines.md
View page @
fec2b769
This page gives information on how to maintain an application once you
This page gives information on how to maintain an application once you
are an application maintainer. If you are looking for information on how
are an application maintainer. If you are looking for information on how
to become an application maintainer, this topic is covered in the
to become an application maintainer, this topic is covered in the
[
FAQ
](
FAQ
)
.
[
FAQ
](
FAQ
)
.
## General Maintainer Information
## General Maintainer Information
Becoming a (super) maintainer gives you certain rights on the
Becoming a (super) maintainer gives you certain rights on the
Application Database. However as you may know, with great power, comes
Application Database. However as you may know, with great power, comes
great responsibility...
great responsibility...
An application maintainer is someone who runs the application regularly
An application maintainer is someone who runs the application regularly
and who is willing to be active in reporting regressions with newer
and who is willing to be active in reporting regressions with newer
versions of Wine and to help other users run this application under
versions of Wine and to help other users run this application under
Wine.
Wine.
### You are expected to:
### You are expected to:
-
Keep the application comments clean, all stale comments should be
-
Keep the application comments clean, all stale comments should be
removed.
removed.
-
Be an active user of that application and version.
-
Be an active user of that application and version.
-
Keep up-to-date with all Wine releases, if there are regressions they
-
Keep up-to-date with all Wine releases, if there are regressions they
should filed as bugs in
[
Bugzilla
](
https://bugs.winehq.org/
)
if there
should filed as bugs in
[
Bugzilla
](
https://bugs.winehq.org/
)
if there
are not bugs already filed.
are not bugs already filed.
-
Periodically submit your own test reports for the versions you
-
Periodically submit your own test reports for the versions you
maintain. Inactive maintainers (currently defined as not logging in
maintain. Inactive maintainers (currently defined as not logging in
for two years) are automatically removed.
for two years) are automatically removed.
-
Process submitted test reports in a timely manner. Maintainers who
-
Process submitted test reports in a timely manner. Maintainers who
fail to process test reports within 7 days are automatically removed
fail to process test reports within 7 days are automatically removed
by the system.
by the system.
### You will:
### You will:
-
Receive an email when a comment is posted or deleted for the
-
Receive an email when a comment is posted or deleted for the
application or the application information is modified
application or the application information is modified
-
Be able to modify all aspects of your application(s) and version(s),
-
Be able to modify all aspects of your application(s) and version(s),
including the description, screenshots, HOWTOs, notes, comments, etc.
including the description, screenshots, HOWTOs, notes, comments, etc.
## Application overview page guidelines
## Application overview page guidelines
*
N.B. Only super maintainers can change the general description of an
*
N.B. Only super maintainers can change the general description of an
application.
*
You can edit an application overview page by clicking on
application.
*
You can edit an application overview page by clicking on
the "Edit Application" button in the application overview page. You will
the "Edit Application" button in the application overview page. You will
be then presented with a form whose fields are explained thereafter.
be then presented with a form whose fields are explained thereafter.
-
Application name should be checked against official application name
-
Application name should be checked against official application name
and should not contain the vendor's name.
and should not contain the vendor's name.
-
Application vendor should be set correctly. If the vendor is missing,
-
Application vendor should be set correctly. If the vendor is missing,
please report on forums.
please report on forums.
-
Keywords are used by the search engine. You don't need to repeat the
-
Keywords are used by the search engine. You don't need to repeat the
application's name but you are encouraged to provide some keywords in
application's name but you are encouraged to provide some keywords in
this field.
this field.
-
Description should describe the application in a general manner (what
-
Description should describe the application in a general manner (what
it does). The Wine and version specific considerations go in
it does). The Wine and version specific considerations go in
version-specific pages (described below). If you want to add more than
version-specific pages (described below). If you want to add more than
a short sentence, please add a carriage return after the first
a short sentence, please add a carriage return after the first
sentence as it will be used when showing the application summary in
sentence as it will be used when showing the application summary in
the search engine, top-25 page and so on.
the search engine, top-25 page and so on.
-
Webpage should contain the home page for this application. Please
-
Webpage should contain the home page for this application. Please
remember that a URL starts with
`http://`
.
remember that a URL starts with
`http://`
.
## Version page guidelines
## Version page guidelines
You can edit a version page by clicking on the "Edit Version" button in
You can edit a version page by clicking on the "Edit Version" button in
any version page for which you are a (super) maintainer. You will then
any version page for which you are a (super) maintainer. You will then
be presented with a form whose fields are explained thereafter.
be presented with a form whose fields are explained thereafter.
-
Version name should be checked against official version name. However
-
Version name should be checked against official version name. However
if you feel that two minor revisions of an application will share the
if you feel that two minor revisions of an application will share the
same problems or success, you are encouraged to use wildcards in the
same problems or success, you are encouraged to use wildcards in the
version number to avoid cluttering the database with hundreds of
version number to avoid cluttering the database with hundreds of
versions. For example if you know that Adobe Acrobat 6.0, 6.01 and 6.1
versions. For example if you know that Adobe Acrobat 6.0, 6.01 and 6.1
are about the same application, just choose 6.x as a version name. You
are about the same application, just choose 6.x as a version name. You
can however use the full version name in a history table in the
can however use the full version name in a history table in the
description field (see below).
description field (see below).
-
Description should describe the application version and not be a
-
Description should describe the application version and not be a
repetition of the application description. Please use a short sentence
repetition of the application description. Please use a short sentence
as the first line of your description to describe what this version
as the first line of your description to describe what this version
is, and then add a carriage return after this first sentence as it
is, and then add a carriage return after this first sentence as it
will be used when showing version summary, in the application page for
will be used when showing version summary, in the application page for
example.
example.
-
Rating lets you rate how this version ran with the latest Wine version
-
Rating lets you rate how this version ran with the latest Wine version
you tested. For rating definitions, please see:
[
Rating
you tested. For rating definitions, please see:
[
Rating
Definitions
](
Rating-Definitions
)
.
Definitions
](
Rating-Definitions
)
.
-
Release is the latest release of Wine you tested this version with.
-
Release is the latest release of Wine you tested this version with.
## Additional URLs guidelines
## Additional URLs guidelines
In both application and version editing pages you can add additional
In both application and version editing pages you can add additional
URLs. These URLs can, for example, help the user find native
URLs. These URLs can, for example, help the user find native
alternatives for this application (in application overview page) or find
alternatives for this application (in application overview page) or find
specific dlls (in version page).
specific dlls (in version page).
## Screenshots guidelines
## Screenshots guidelines
As a maintainer you are encouraged to provide screenshots for the
As a maintainer you are encouraged to provide screenshots for the
versions you tested under Wine. To add a screenshot, simply click on the
versions you tested under Wine. To add a screenshot, simply click on the
screenshot thumbnail in the version page.
screenshot thumbnail in the version page.
## Notes guidelines
## Notes guidelines
In the version page you can add, edit and delete notes for the versions
In the version page you can add, edit and delete notes for the versions
you maintain. Just click on the "Add note" button.
you maintain. Just click on the "Add note" button.
## HOWTO guidelines
## HOWTO guidelines
HOWTOs are just a special kind of notes. You can provide step-by-step
HOWTOs are just a special kind of notes. You can provide step-by-step
explanations on how to install or run a specific version of the current
explanations on how to install or run a specific version of the current
application here. Please try to keep HOWTOs up to date (for example some
application here. Please try to keep HOWTOs up to date (for example some
steps might no longer be needed if using a more recent version of Wine).
steps might no longer be needed if using a more recent version of Wine).
## Warnings guidelines
## Warnings guidelines
Warnings are just a special kind of note. Warnings appear in red to
Warnings are just a special kind of note. Warnings appear in red to
catch the attention of the reader. They can be used to warn users
catch the attention of the reader. They can be used to warn users
against potential data corruption for instance. Please keep the warning
against potential data corruption for instance. Please keep the warning
up-to-date, especially if it is not true when using a recent Wine
up-to-date, especially if it is not true when using a recent Wine
version (in this case you might choose to keep the warning and tell
version (in this case you might choose to keep the warning and tell
users that since Wine X.Y, this has been fixed).
users that since Wine X.Y, this has been fixed).
## Comments guidelines
## Comments guidelines
As a maintainer you are entitled to delete comments. Use this feature
As a maintainer you are entitled to delete comments. Use this feature
wisely and always explain why you deleted a comment.
wisely and always explain why you deleted a comment.
Comments containing any of the following should be deleted immediately:
Comments containing any of the following should be deleted immediately:
-
Links to illegal downloads or discussions of how to obtain or use them
-
Links to illegal downloads or discussions of how to obtain or use them
-
Spam
-
Spam
-
Off-topic discussions
-
Off-topic discussions
Users who repeatedly post such comments should be reported on
[
the
Users who repeatedly post such comments should be reported on
[
the
Website Issues section of the
Website Issues section of the
forum
](
https://forum.winehq.org/viewforum.php?f=11
)
.
forum
](
https://forum.winehq.org/viewforum.php?f=11
)
.
If a comment is outdated, you can safely delete it. Whenever you can,
If a comment is outdated, you can safely delete it. Whenever you can,
extract how-tos, other people's tests (for your test history table for
extract how-tos, other people's tests (for your test history table for
example) from the comments and put it in your versions page and how-to
example) from the comments and put it in your versions page and how-to
notes.
notes.
If users paste large amounts of debug/crash output from wine, it might
If users paste large amounts of debug/crash output from wine, it might
be a good idea to delete their comment and depending on whether or not a
be a good idea to delete their comment and depending on whether or not a
bug report as been filed for the problem, ask them to file a report and
bug report as been filed for the problem, ask them to file a report and
attach the information.
attach the information.
## Using the HTML editor
## Using the HTML editor
The HTML editor allows users of the AppDB to write richer descriptions,
The HTML editor allows users of the AppDB to write richer descriptions,
guides or warnings by providing a WYSIWYG HTML editor. The HTML editor
guides or warnings by providing a WYSIWYG HTML editor. The HTML editor
can be disabled in your Preferences which will allow you to edit the
can be disabled in your Preferences which will allow you to edit the
html source of various fields.
html source of various fields.
## Contacting Us
## Contacting Us
If you have additional questions, please do not hesitate to contact us
If you have additional questions, please do not hesitate to contact us
on our
[
forums
](
https://forum.winehq.org/
)
.
on our
[
forums
](
https://forum.winehq.org/
)
.