Skip to content

Latest commit

 

History

History
55 lines (50 loc) · 2.2 KB

CONTRIBUTIONS.md

File metadata and controls

55 lines (50 loc) · 2.2 KB

Contrbutions

Eclipse XRAY has 3 ways for community members to contribute: Adding dApps, Labeling Programs, and Writing Code.

Adding dApps

dApps can be added to src/lib/dapps.json in the following format:

    {
        "name": "My dApp",
        "description": "A description or tagline about the dapp",
        "icon": "/media/dapps/mydapp.jpg",
        "link": "https://my-dapp.com/",
        "network": "mainnet"
    }

dApp icons/images should be added to src/static/media/dapps and have reflect the filename and path format shown above. The network field should reflect one of the following:

  • "mainnet"
  • "testnet"
  • "devnet"
  • "pre-launch" To submit, open a PR and leave a semi-detailed note about the dApp you are adding.

Labeling Programs

Programs can be labeled via Eclipse XRAY's config file or directly in the Eclipse Program Registry.

Contributing to Eclipse XRAY Config:

Contributions to src/lib/config.ts should be reflect the following examples:

For Program IDs:

    "BPFLoaderUpgradeab1e11111111111111111111111": { name: "BPF Loader Upgradeable", category: "SYSTEM" },

For Tokens and Pyth Price Feeds:

      SOL: {symbol: 'SOL', priceFeedId: '0xef0d8b6fda2ceba41da15d4095d1da392a0d2f8ed0c6c7bc0f4cfac8c280b56d', aliases: ['Solana'], mint: 'BeRUj3h7BqkbdfFU7FBNYbodgf8GCHodzKvF9aVjNNfL'},

To submit, open a PR and leave a semi-detailed note about the program address you are adding, and any public listing of the listed address.

Contributing to the Eclipse Program Registry:

Visit https://github.com/Eclipse-Laboratories-Inc/program-registry and submit a PR in the following format:

- name: Some Program
  description: Some Program Description 
  repo: https://github.com/some/program
  icon: https://someprogram.com/image
  framework: NextJS
  program_address: "0xSomeProgram"
  categories:
    - Category 1
    - Category 2
    - Category 3

Visit the above link for more info about contributions to the EPL

Writing code

We are currently gearing up for community contributions, but you can find a list of open tasks in .todo if you are a spirited developer with some free time on your hands