Beta Features/Package

From MediaWiki.org
Jump to: navigation, search
Beta experiments icon.png

Beta Features help Wikimedia designers and engineers test out new features or significant changes to existing features.

Basic Requirements[edit]

Projects added to Beta Features must meet the following requirements:

  • Not significantly degrade site performance;
  • Not noticeably degrade perceived performance of the site, or the user's system;
  • Not crash the user's browser;
  • Not cause data loss, or corruption; and
  • Contribute positively to the user's experience of the site, and be additive in nature. e.g. Beta Features cannot be used to remove site features or functionality without adding features meant to replace what was removed.
  • Pass basic interoperability with other Beta Features features (this is not to say that interoperability is a blocker. Interoperability issues need to be surfaced, and blocker-ness will be determined on a case-by-case basis).

To check that these requirements are met, be sure to test your new feature on this WMF beta server for at least one week before deploying to production. This testing period is intended to catch any serious bugs before jeopardizing users on production.

Getting Ready[edit]

What do I need to do to get my project ready for Beta Features?

We invite developers who want to test features through this project to post their submission on this queue for new Beta Features.

To that end, here are some tips on how to prepare your feature package for inclusion in Beta Features.

Feature Name[edit]

Be brief, be descriptive, and if possible be fun, or at least don't talk like a robot.

Style: Use Title Case, don't use the word experiment, feature, or beta, in the name of your feature

Good = Bigger Pictures, Bad = Enlarged lightbox Image Experiment

Details: 30 characters max length, one line, no wrapping.

Feature Description[edit]

Tell users what your feature does, why they would want to turn it on, and any major issues they may encounter.

Details: 255 character limit

Feature Images[edit]

Please use the Feature Image Template or work with May Galloway to create an Image for your feature.

Use template https://commons.wikimedia.org/wiki/File:BetaFeature_Image_template.svg

Details: SVG, will be displayed at approximately 200 px wide by 100 px tall. RTL, and LTR versions if applicable.

Project Page Link[edit]

Provide a link to the MediaWiki project page for the feature, this is a simple, straightforward page written in the user's language, it may not be the same as the project page used internally for development.

Talk Page Link[edit]

Note: We want to use Flow for discussion of Beta Features. It is confusing for a talk page to change from a wiki page to a Flow discussion mid-conversation.

Details: Talk page is assumed from Project Page Link, however it can be localized (i.e. pass Beta Features a message, it passes the user a link with their language's link)

Browser and Platform Compatibility List[edit]

Provide a list of browsers or platforms with which the feature is incompatible.

Provide error string if for some reason the default error string "This Beta Feature is not yet compatible with your browser" isn't good enough.

Details: If providing alternate error text, please keep it brief and non technical.

Prerequisites[edit]

Provide the names of any other Beta Features that must be enabled for your Beta Feature to function correctly.

Post your Submission[edit]

When your new Beta Feature is ready, please write a detailed description and post your submission on this New Features page. This will help WMF Engineering, Design and Product teams discuss your feature and coordinate its deployment with you.

Release Requirements[edit]

  1. Make an extension
  2. Get prelim design review
  3. Get prelim security review
  4. Get prelim performance review
  5. Make sure there is a wiki page on mw.org for it that is understandable to the general public
  6. Flowify the Talk page for the project
  7. Make sure there is someone on point for feedback - a product manager (either volunteer or WMF staff)
  8. Make a phabricator project for the extension
  9. Enable the Final Version of the code on Beta Cluster at least a week before you want to go for production.
  10. Make gerrit change (do not merge) to the BF whitelist in mediawiki config
  11. Deploy!

"Graduation" requirements[edit]

  1. Most people are happy with your feature/change
  2. It's agreed to be a good addition to the site, balancing features, design complexity and performance
  3. All major bugs and obviously missing features are fixed
  4. It passes a second design, security and performance review
  5. You have run it as the Beta Feature in "final configuration" (with only the bits you intend to deploy, and no others) for at least two week before deployment.
  6. Get agreement from James/Greg.
  7. Merge your code into an appropriate venue (MW-core or an existing extension) behind a feature flag.
  8. Deploy, removing your BF code from the servers and the BF whitelist entry from mediawiki config.