Skip to content

Latest commit

 

History

History
67 lines (50 loc) · 1.98 KB

File metadata and controls

67 lines (50 loc) · 1.98 KB

Contributing

This repository is a static directory of Bangladeshi tech professionals. The source of truth is:

profiles/*.yml

Quick Start

  1. Fork the repository.
  2. Create a new branch.
  3. Copy profiles/_template.yml to profiles/<your-github-username>.yml.
  4. Fill in your information.
  5. Run npm install and npm run validate.
  6. Open a pull request.

Profile Rules

  • One contributor profile per file.
  • Do not add slug or slug_source in YAML. They are computed automatically.
  • If you have a GitHub profile, use your GitHub username as the filename.
  • If you do not have GitHub, use a slugified version of your name as the filename.
  • version: 1 is required.
  • availability must be one of: available_now, open_to_opportunities, available_in_2_weeks, not_available, unknown.
  • preferred_work_type must be one of: remote, hybrid, onsite, flexible.
  • skills must be an array of strings.
  • experience_years must be numeric.
  • LinkedIn URLs are validated but never scraped.
  • Keep optional links as null when you do not use them.

What Gets Enriched Automatically

  • GitHub username, public profile metadata, public repos, languages, repo activity, and detected GitHub skills.
  • Portfolio title, meta description, canonical URL, OG image, and lightweight link signals.

What Is Not Scraped

  • LinkedIn
  • Private repositories
  • Deep portfolio crawling

Local Commands

npm run validate
npm run build:submitted
npm run enrich:github
npm run enrich:portfolio
npm run build:data
npm run build:dashboard
npm run generate:readme
npm run sync

Generated Files

Do not edit generated JSON by hand unless a maintainer explicitly asks for it.

  • generated/developers/<slug>.json
  • generated/developers.index.json
  • generated/dashboard/dashboard.json

Notes For Maintainers

  • Keep submitted data and machine-enriched data separate.
  • Preserve missing or ambiguous legacy values honestly.
  • Avoid adding infrastructure that makes contribution harder.