diff --git a/contributing.md b/contributing.md index 3967461d406..cd7a7199577 100644 --- a/contributing.md +++ b/contributing.md @@ -10,6 +10,23 @@ The following is a set of guidelines for contributing to `electron-apps`. These are just guidelines, not rules. Use your best judgment and feel free to propose changes to this document in a pull request. +## Contents + +* [Adding your app](#adding-your-app) + + [Using the wizard 🔮](#using-the-wizard-%F0%9F%94%AE) + + [Adding your app by hand 💪](#adding-your-app-by-hand-%F0%9F%92%AA) + + [YML File Rules](#yml-file-rules) + + [Categories](#categories) + + [Screenshots](#screenshots) + + [Colors](#colors) + + [Icons](#icons) + + [Locales](#locales) + + [Company Logos and Names](#company-logos-and-names) + + [Submission Guidelines](#submission-guidelines) +* [Removing or Disabling Apps](#removing-or-disabling-apps) +* [Development](#development) +* [Testing](#testing) + ## Adding your app If you have an Electron application you'd like to see added, please @@ -172,6 +189,19 @@ Some things to keep in mind when preparing your app for submission. Heavily insp - Don't start the description with `A` or `An`. - Check your spelling and grammar. +## Removing or Disabling Apps + +Sometimes it's necessary to remove an app for this registry. To do so, +add a `disabled` property to the app's YML file, followed a comment +explaining the reason for removing it. + +```yml +disabled: true # Nylas was sunset and replaced by Mailspring +``` + +This approach keeps the app data on hand, giving the app developer +an option to resurrect the app at a later date by simply removing the flag. + ## Development To develop this thing locally, there are a few things you should know: