How to add your project to our Partner-Registry repo.
Firstly you need to fork the registry repo, clone it locally and open in your favorite editor.
The info.yaml
file looks like this:
name: 'Test Partner' # 20 characters max
short_description: 'Test Partner' # 60 character max description
long_description: 'This is a test and is ignored by the uploader' # 175 character max
tags: # max 3 tags, the most relevant should be listed first
- 'defi' # no more then 12 characters per tag
- 'infra'
url: 'https://www.autonity.org' # must be a valid https url
The thumbnail.png
must be no more than 196x160px. This is used when viewing your project in the grid list.
The banner.png
must be no more than 274x105px. This is used when your product is featured and is in the carousel list.
When you submit your PR, please use the following naming convention for the title:
- Title Format:
Add <Project Name> to Partner Registry
- Example:
Add MyProject to Partner Registry
If you are successfull, your PR will have a new-partner
label applied to it:
And a success comment
If your PR failed validity checks, a bot will comment on the reasons why