Skip to content

Latest commit

 

History

History
88 lines (67 loc) · 2.28 KB

README.md

File metadata and controls

88 lines (67 loc) · 2.28 KB
Raw

Cronos Logo


Cronos Ecosystem Project Template

The documentation in this repository site provides the template and specifications details to submit ecosystem projects to be included on the Cronos ecosystem page.

Getting Started

Prerequisites

You're going to need:

gh-cli

Getting Set Up

  1. Fork this repository on Github
  2. Clone your forked repository (not our original one) to your hard drive with git clone https://github.com/{username}/cronos-awesome.git
  3. cd cronos-awesome
  4. Make a copy of MAKE_COPY.json, rename the copy, move it under projects directory and start filling out the fields. Please keep the content in MAKE_COPY.json unchanged.

Fields

  1. name: The official name of your project
  2. category: Select up to 3 items from Categories below
  3. logo: Url to your logo
  4. description: Brief Project Description,
  5. link: Url to your website
  6. twitter: Url to your Twitter

Note: If your project belongs to more than one category, you can add each secondary category as a comma separated entry. (e.g. ["Farm", "NFT"] etc.)

Categories (Select up to 3 categories)

Bridge, DEX, Farm, Gaming, Infrastructure, Launchpad, Lending, Metaverse, News, NFT, Options, Others, Reserve Currency, Stablecoin, Structured Finance, Tools, Wallet, Web3, Yield Optimiser,

Commit Changes

git add .
git commit -m "commit comment"
git push -u origin main

Note: Please make sure, you push to your forked repository

Create Pull Request

if not Authenticated yet please run:

gh auth login

If the git CLI prompts the following:

Which should be the base repository (used for e.g. querying issues) for this directory

Select the following base repository:

crypto-org-chain/cronos-awesome

Then:

gh pr create --base staging --head ${username}:main

This will programatically create PR based on your commit. Once we receive the PR we will review the project details and format.

Note: We only accept PRs to our staging branch.

Once review and approved, you should see your projects on crypto-org-chain/cronos-awesome/tree/staging.