Skip to main content

Data Submission via Git (Advanced)

This method is for technical users who are comfortable with Git and prefer to contribute directly to the repository.

Step-by-Step Guide:​

1. Fork the Repository​

First, you need to create your own copy (a "fork") of the AMDB repository.

  • Go to the AMDB GitHub Repository.
  • Click the Fork button in the top-right corner. This will create a copy under your own GitHub account.

2. Clone Your Fork​

Next, clone the forked repository to your local machine so you can make changes.

git clone https://github.com/YOUR_USERNAME/amdb.git
cd amdb

3. Create a New Branch​

It's best practice to create a new branch for your changes. This keeps your work organized and separate from the main branch.

git checkout -b add-my-l1-metadata

Give your branch a descriptive name, like add-my-awesome-l1.

4. Add or Edit Files​

  • Find the correct folder: Navigate to amdb/mainnet/l1s or amdb/fuji/l1s.
  • Create your JSON file: Create a new folder and a .json file based on the schema guides. For example, l1s/my-l1/my-l1.json.
  • Fill in the data: Carefully fill in all the required information. You can find the complete JSON structure and explanations for each field in the Metadata Schemas.
  • Add assets: If your submission requires a logo, add it to an assets subfolder (e.g., l1s/my-l1/assets/logo.png).

5. Commit and Push Your Changes​

Once you are done, save your changes, commit them with a clear message, and push the branch to your fork on GitHub.

git add .
git commit -m "feat: Add metadata for My Awesome L1"
git push origin add-my-l1-metadata

6. Open a Pull Request​

  • Go to your forked repository on GitHub.
  • You will see a prompt to "Compare & pull request". Click it.
  • Make sure the base repository is coreappsio/amdb and the head repository is your fork and branch.
  • Add a clear title and description for your pull request, explaining the changes you made.
  • Click "Create pull request".

Our researchers will then review your submission, provide feedback if necessary, and merge it into the database.