Skip to content

Visão geral ​

Suas opções para personalizar o OpenSpec.

O OpenSpec oferece várias opções de personalização. Esta página mostra o que cada uma altera e quando usá-la.

O que você pode personalizar ​

OpçãoO que alteraQuando usar
ProfilesQuais workflows são instalados e de que forma: como skills, comandos ou ambosVocê quer workflows e padrões de trabalho adicionais, ou remover workflows de que não precisa
Configuração do projetoAs instruções injetadas em cada execução de workflow: contexto, regras e orientações de operação (config.yaml)Você quer que as mudanças sejam planejadas do seu jeito, como tarefas que sempre incluem testes com Playwright
SchemasO que o OpenSpec produz: os artefatos, sua ordem e seus templatesAs mudanças devem produzir arquivos de planejamento, seções ou formatos diferentes

Não sabe qual usar? ​

Config e schemas são dois níveis de personalização. Escolha de acordo com o quanto você quer se aprofundar:

  • Comece pela configuração do projeto: é mais leve e, para a maioria dos projetos, é suficiente. Você mantém os artefatos padrão e adiciona por cima o seu próprio contexto e suas regras.
  • Faça fork de um schema quando adicionar não for suficiente: a config apenas adiciona por cima do workflow principal. Ela pode adicionar uma regra como "as tarefas sempre incluem testes", mas não pode remover o documento de design nem renomear um arquivo. Isso é território de schema. Fazer fork lhe dá uma cópia própria para editar.

Aqui, "fork" significa o comando openspec schema fork, não fazer fork de um repositório git. Schemas traz os detalhes.

flowchart LR
    a["Os workflows devem conhecer meu stack e minhas convenções"] --> config
    b["Um artefato precisa de uma regra extra, como tarefas que sempre incluem testes"] --> config
    c["Artefatos, nomes de arquivo ou estrutura de documento diferentes"] --> schema
    d["As instruções embutidas afirmam coisas que minha equipe faz de forma diferente"] --> schema
    config["Configuração do projeto<br/>(config.yaml)"]
    schema["Fazer fork de um schema<br/>(openspec schema fork)"]