Labelling Issues - wp-media/wp-rocket GitHub Wiki
Labels are used on issues and pull requests to identify:
- The related module in WP Rocket
- The type of issue (new feature/enhancement/bug)
- The severity of the issue in case of a bug
- The status of the issue
- Some other useful indicators
You'll find below the list of labels for each category and an explaination of it's purpose.
Modules
module: browser cache
- for issues related to our browser caching features, mainly htaccess rules for Apachemodule: cache
- for issues related to our cache featuremodule: CDN
- for issues related to our CDN featuremodule: cloudflare
- for issues related to our Cloudflare Add-Onmodule: dashboard
- for issues related to our dashboard tab on settings page or the general WP admin areamodule: database
- for issues related to our database optimization featuremodule: Facebook Pixel Add-On
- for issues related to our Facebook Pixel Add-Onmodule: file optimization
- for issues related to our file optimization features: HTML/CSS/JS filesmodule: Google Tracking Add-On
- for issues related to our Google Tracking Add-Onmodule: heartbeat
- for issues related to our Heartbeat control featuremodule: lazyload
- for issues related to our lazyload featuremodule: logger
- for issues related to our debug log feature (in development)module: media
- for issues related to our media features: Emojis, Embeds, WebPmodule: preload
- for issues related to our preload featuremodule: sucuri
- for issues related to our Sucuri Add-Onmodule: tools
- for issues related to our tools tab on the settings pagemodule: Varnish
- for issues related to our Varnish Add-On
Types
feature request
- for requests of new features in the plugintype: bug
- for issues identified as a bug to be fixedtype: enhancement
- for issues concerning an improvement of something existing in the plugintype: new feature
- for issues concerning a new feature of the plugin
Severity
severity: critical
- for issues that are breaking the plugin (Fatal error for example)severity: major
- for issues that are impacting a large number of our usersseverity: minor
- for issues that are impacting a small number of our users, or on very specific areaseverity: trivial
- for issues that are impacting a very small number of our users, or typography mistakes
Status
help wanted
- an issue currently blocked because the assigned contributor needs help on itduplicate
- for opened issues that are a duplicate of an already opened oneinvalid
- for issues that are not appropriate for the pluginneeds copywriting
- for issues that needs work on copy before continuingneeds design
- for issues that needs design work before continuingneeds testing
- for issues that needs testing to determine if they are valid/how to resolve themtriage
- for issues that needs to be reviewed to determine if they are still validwaiting for feedback
- for issues that needs feedback before continuingwontfix
- for issues that we won't fix
Others
3rd party
- for issues or compatibilities related to another product (hosting/plugins/themes)Beacon
- for issues related to HelpScout Beacon integrationcommunity
- mainly used for pull requests submitted by our usersdesign
- for anything touching the design, mostly in the settings page areagood first issue
- for issues that are good as a starting point to contribute to the plugini18n
- for issues related to internationalization in the pluginmultisite
- for issues related to WP multisiteOnboarding
- for issues related to the onboarding process (TBA)question
- for issues that are not a problem, but a question about how something works for example