Skip to content

Latest commit

 

History

History
51 lines (51 loc) · 2.55 KB

File metadata and controls

51 lines (51 loc) · 2.55 KB

Contributing

I want to add my application

To add your application you need to have manifest-info.json file. It is required to have link in manifest-info. Here is an example of good manifest-info:

// Good `manifest-info` example
{
    "name": "informative_name",                                               // REQUIRED
    "description": "Here is my great application that I'm ready to publish.", // 
    "author": "informative_author_name",                                      // 
    "version": "1.0.0",                                                       // REQUIRED
    "agree": true,                                                            // REQUIRED
    "link": "https://...",                                                    // REQUIRED
    "company": ""                                                             // 
}

Here is a BAD example of manifest-info:

// BAD `manifest-info` example
{
  "name": "AmAZ%*ing.,/\aPPlICAT%!ion"
                    "author": "somebody",
"version": "Why would I need a version?",    // :D PLEASE aDd my apP:)
    "agree": false
}

Name requirements

  1. Your name must be from a to z, contain only lowercase characters. It can also contain these characters: -_0123456789.
    Here is a regex of name requirements: [a-z0-9_\-].
  2. Name mustn't already exist. If name already exists, issue will be declined.

Version requirements

Regex: (\d\.){2}\d{1,4}

Agreement

You have to set "agree" to true if you agree and you want to publish your application.

Identation requirements

manifest-info should have at least 1 tabulation. Identation mustn't change.

Publishing

  1. Go to issues.
  2. Click "New issue":
    "New Issue" button
  3. Select the first template and click "Get started":
    Application template
  4. Change the required (and optionally, optional) fields.

Wrong format

You cannot sumbit your app with wrong format. Issue will be declined.

As PR

PRs (Pull Requests) are not supported now. Only these pulls are accepted.

Owner

Owner also can create issues and accept them by himself.

I want to correct something in this repository

Send a pull request. It will be reviewed by trusted members.