YABP•
GitHub
Back to Showcase
Developer Guide

Contributing & Submission Guide

How to list your minimal, high-utility developer tool in the official YABP directory and configure 2-way trust verification.

Last Updated: October 2026 Manual Review & CI Check Curated Initial Stage

Mandatory Developer Agreement & Curation Notice

YABP is in its initial stage: submissions take longer to appear because every single project is manually reviewed and verified by maintainers. We curate strictly to showcase only the best tools; any project may be removed at any time without prior notice if it fails to maintain quality, introduces tracking, or becomes abandoned. By submitting, you agree to our Terms of Use and Security Policy.

1 Submission Workflow

Follow these step-by-step instructions to prepare your repository and submit a pull request:

Step 1: Fork and Clone

Fork the Yet-Another-Boring-Project repository to your personal GitHub account and clone it to your local development environment:

Terminal Command 
git clone https://github.com/YOUR_USERNAME/Yet-Another-Boring-Project.git
cd Yet-Another-Boring-Project

Step 2: Update projects.json

Open projects.json and append your project object to the "projects" array:

JSON Structure (projects.json) 
{
  "name": "Your Project Name",
  "date": "2026-10-24",
  "description": "A clear, single-sentence explanation of what your project does.",
  "link": "https://your-live-demo-or-website.com",
  "github": "https://github.com/yourusername/your-repository"
}
Field Type Constraint Description
name String 1-50 characters Short, recognizable project title.
date String YYYY-MM-DD Date of submission or project launch.
description String 10-150 characters Concise utility summary. Avoid promotional hype or clickbait.
link String Valid URL or "" Live web application or interactive demo URL.
github String Valid URL or "" Public GitHub repository containing the open-source code.

Step 3: Add Logo Badge (2-Way Verification)

All directory members must display the official YABP logo badge in their repository README file. By appending your project's exact live link or GitHub URL, when visitors click the badge in your README, the YABP portal automatically looks up and verifies your membership!

Interactive Badge & Link Generator

Type your project's live URL or GitHub repository URL below to generate your ready-to-paste badge codes:

* Ensure this exact URL matches either the "link" or "github" field in your projects.json entry.
YABP Initiative Logo
README HTML Badge (Mandatory for Repositories) 
<a href="https://yabp.netlify.app/?verify=YOUR_PROJECT_URL">
  <img src="https://raw.githubusercontent.com/dheeraz101/Yet-Another-Boring-Project/main/logo.png" width="48" height="48" alt="YABP Initiative Logo" style="display: inline-block; vertical-align: middle;" />
</a>
README Markdown Badge 
[![YABP Initiative Logo](https://raw.githubusercontent.com/dheeraz101/Yet-Another-Boring-Project/main/logo.png)](https://yabp.netlify.app/?verify=YOUR_PROJECT_URL)
Direct Verification Link (For Apps & UI) 
https://yabp.netlify.app/?verify=YOUR_PROJECT_URL

Step 4: Local PR Validation

Before opening your pull request, test your JSON formatting locally using the official verification script:

Terminal Command 
node .github/scripts/verify-projects.js

Commit your changes, push to your fork, and submit a Pull Request. Automated GitHub Actions CI checks will run the validator on your PR.

Step 5: Manual Verification & Curation Review

Initial Stage Manual Verification & Curation Notice:

Because YABP is in its initial stage, projects take longer to appear in the directory. Every submission is personally checked, functionally tested, and verified by our maintainers to ensure exceptional utility, stability, and zero tracking before approval.

Curated Quality Standard: Only the best, highest-utility tools will be kept in the showcase. Any project may be removed at any time without prior notice if it becomes unmaintained, introduces telemetry, or degrades in quality. Once merged and verified, global CDN cache invalidation typically synchronizes within 5-10 minutes.

Developer Agreement & Pre-Flight Checklist

Before opening your pull request, please review and confirm agreement with our community standards:

0 of 4 verified (0%) Open Pull Request

2 Design and Quality Criteria

Submissions are manually reviewed according to these core principles:

  • Minimalist Design (Apple HIG Inspired): High contrast, clean typography, balanced spacing, and zero superfluous UI noise.
  • Utility Focus: Must solve a real developer problem, automate a tedious workflow, or boost focus. No basic tutorial homework repos or joke scripts.
  • Production Ready: No broken links, "Under Construction" placeholders, or incomplete components.
  • Strict Privacy (Zero Trackers): No third-party ad networks, trackers, user telemetry, or analytics fingerprinting scripts.
  • Active Open Source License: Your repository must include an OSI-approved or standard permissive open-source license (such as MIT, Apache 2.0, BSD).