aaaalabs/arkify

Add more diverse example YAML files

Ouverte

#3 ouverte le 22 oct. 2025

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)Python (1 fork)auto 404
documentationgood first issue

Métriques du dépôt

Stars
 (0 étoile)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

Description: Create 5+ diverse project examples showing Arkify's versatility across different project types.

Examples needed:

  • Mobile app project (React Native, Flutter, Swift)
  • API/backend service (Node.js, Django, Rails)
  • Chrome extension
  • Open source library/package
  • Freelance client work
  • E-commerce site
  • Developer tool/CLI

Todo:

  • Create new YAML files in examples/ folder
  • Use real or realistic project data
  • Include all required fields (name, hours, cost, tech_stack, learning)
  • Optionally include extended fields (results, expectations vs reality)
  • Test with: python arkify.py examples/your-project.yaml

Good for: First-time contributors, anyone who's built side projects!

Template:

project:
  name: "Your Project Name"
  tagline: "One-line description"
  hours: 42
  cost: 100
  tech_stack:
    - "Tech 1"
    - "Tech 2"
    - "Tech 3"
    - "Tech 4"
  learning: "Your key insight"

See existing examples in examples/ folder for inspiration!

Guide contributeur

Direction de recherche
Étudiez les exemples YAML existants dans le dossier examples/, choisissez un type de projet dans la liste et créez un nouveau fichier YAML en suivant le modèle. Testez votre fichier avec `python arkify.py examples/your file.yaml`.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitPython
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85