aaaalabs/arkify

Add more diverse example YAML files

Aberta

#3 aberto em 22 de out. de 2025

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (0 responsável)Python (1 fork)auto 404
documentationgood first issue

Métricas do repositório

Stars
 (0 estrela)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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!

Guia do colaborador

Direção de pesquisa
Estude os exemplos YAML existentes na pasta examples/, escolha um tipo de projeto da lista e crie um novo arquivo YAML seguindo o modelo. Teste seu arquivo usando `python arkify.py examples/your file.yaml`.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitPython
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85