Skip to content
microfeed by Listen Notesmicrofeed by Listen Notesmicrofeed docs

Contribute to microfeed

microfeed is open source under the GNU Affero General Public License v3.0. Contributions can improve the application, management CLI, documentation, tests, accessibility, or examples.

Start a development environment

Section titled “Start a development environment”
Terminal window
git clone https://github.com/microfeed/microfeed.git
cd microfeed
corepack enable
yarn install --immutable
yarn manage init --local --instance local-development
yarn manage dev --instance local-development

Local development uses isolated simulated D1 and optional R2 data. It does not copy production content.

To run the documentation site instead:

Terminal window
yarn docs:dev

Before proposing a change

Section titled “Before proposing a change”
  1. Create a focused branch from the latest main.
  2. Keep application code under src/, management tooling under manage-cli/, and documentation-site content under docs/.
  3. Keep the canonical command references synchronized whenever behavior changes: management CLI, @microfeed/cli, and @microfeed/theme-kit.
  4. Add or update tests for observable behavior.
  5. Run git diff --check and yarn check.
  6. Stop any development server you started.

Open a focused pull request that explains the outcome, validation, and any manual checks. Use GitHub Issues for bugs and Discussions for broader ideas.