Skip to content

Latest commit

 

History

History
79 lines (56 loc) · 1.81 KB

eco-apps.mdx

File metadata and controls

79 lines (56 loc) · 1.81 KB
Raw

Contributing to Ecosystem Apps

How to Contribute

  1. Fork the repository

  2. Clone your fork:

    git clone https://github.com/your-username/sei-docs.git
cd sei-docs

  3. Create a new branch:

    git checkout -b add-new-app

  4. Add your app data:

    • Open data/appData.ts.
    • Add your app to the appData array with the required fields (title, description, href, image, tags).
    • Make sure to use the appropriate tags from the Tag enum.
      • If there are no suitable tags, make one!

  5. Add your app image:

    • Save your app logo image in the public/assets/ecosystem/ directory. [must be a square .png]
    • Import the image at the top of data/appData.ts.
    • Use the imported image in the image field of your app data.

  6. Commit your changes:

    git add data/appData.ts public/assets/ecosystem/[your-image-file]
git commit -m "Add new app: [Your App Name]"

  7. Push your changes:

    git push origin add-new-app

  8. Create a pull request:

    • Go to the original repository on GitHub.
    • Click on "New pull request" and select your branch to create the PR.

App Data Format

Please ensure your app data follows this format:

{
    title: "App Title",
    description: "A brief description of the app",
    href: "https://app-url.com",
    image: appImage,
    tags: [Tag.YOUR_TAG]
}

Tags

Available tags are defined in the Tag enum in data/appData.ts. Here are some examples:

  • BET: Betting
  • BOT: Bots
  • BRIDGE: Bridge
  • DEFI: DeFi
  • ...

Images

  • Save your app logo image in the public/assets/ecosystem/ directory.
  • Import the image at the top of data/appData.ts.
  • Use the imported image in the image field of your app data.

Thank you for contributing!