Share Your Profiles

Got a profile collection others might find useful? Here's how to add it to the showcase.

Prerequisites

• amoxide installed
• A GitHub account

Step by step

Let's say your GitHub handle is john and you want to share your git conventional commit profiles.

1. Fork the repository

Go to github.com/sassman/amoxide-rs and click Fork (top right). This creates your own copy at github.com/john/amoxide-rs.

2. Clone your fork

git clone git@github.com:john/amoxide-rs.git
cd amoxide-rs

3. Create a branch

git checkout -b community/john-git-conventional

4. Copy the template

cp -r community/TEMPLATE community/john-git-conventional

This gives you:

community/john-git-conventional/
├── README.md     ← edit this
└── profiles.toml ← replace with your export

5. Export your profiles

Replace the template profiles.toml with your actual export:

am export -p git-conventional > community/john-git-conventional/profiles.toml

Or export multiple profiles:

am export -p git -p git-conventional > community/john-git-conventional/profiles.toml

6. Edit the README

Open community/john-git-conventional/README.md and fill in the frontmatter:

---
author: john
description: Git aliases for conventional commit workflows
category: git
tags: [git, conventional-commits, workflow]
profiles: [git, git-conventional]
---

Then write a few sentences about what your aliases do, how you use them, and any tools that need to be installed.

Frontmatter reference

Field	Required	Description
author	yes	Your GitHub handle
description	yes	One-line summary (shown on the tile)
category	yes	One of: git, docker, rust, k8s, python, node, misc
tags	yes	Array of keywords for filtering
profiles	yes	Profile names included in your profiles.toml
shell	no	Only set if your aliases use shell-specific syntax (e.g. fish)

7. Test it

Make sure the import works:

cat community/john-git-conventional/profiles.toml | am import --yes

8. Commit and push

git add community/john-git-conventional/
git commit -m "community: add john-git-conventional"
git push origin community/john-git-conventional

9. Open a Pull Request

Go to your fork on GitHub — you'll see a banner to create a Pull Request. Click it and select the Community Profile PR template.

The checklist will guide you through what's needed:

• [ ] Folder named community/john-git-conventional/
• [ ] profiles.toml is a valid am export output
• [ ] README.md has the required frontmatter
• [ ] Only files in your own folder are modified
• [ ] Import tested locally

Your contribution will appear on the showcase after review.

Rules

• Only add or modify files in your own folder
• One folder per alias collection (multiple profiles in one profiles.toml is fine)
• For a second collection, create a second folder (e.g. john-docker-compose)

What makes a good contribution?

• Useful to others — aliases that solve common workflows
• Well documented — explain what each alias does
• Self-contained — note any dependencies
• Tested — verify the import works

Security

All submissions are reviewed before merging. We check for suspicious content, but you should always inspect aliases before importing — even from this showcase.