Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Write Contracts ReadMe #20

Open
LeonardoVieira1630 opened this issue Nov 26, 2024 · 0 comments
Open

Docs: Write Contracts ReadMe #20

LeonardoVieira1630 opened this issue Nov 26, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@LeonardoVieira1630
Copy link
Member

LeonardoVieira1630 commented Nov 26, 2024

Criar documentação principal dos contratos explicando sua estrutura e funcionamento:

  • Documentar Scorer Contract:

    • Visão geral e propósito
    • Estrutura de dados principais
    • Sistema de permissões (Creator/Manager)
    • Funcionalidades de scores e badges
    • Exemplos de uso das funções principais
    • Eventos emitidos
  • Documentar Scorer Factory Contract:

    • Propósito e integração com Scorer
    • Sistema de criação de novos Scorers
    • Funcionalidades de consulta
    • Exemplos de criação e consulta
  • Instruções de Desenvolvimento:

    • Setup do ambiente
    • Como executar testes
    • Comandos principais
    • Estrutura do projeto
    • Padrões de código
  • Informações de Segurança:

    • Considerações de permissões
    • Limites e validações
    • Boas práticas de uso
@LeonardoVieira1630 LeonardoVieira1630 self-assigned this Nov 26, 2024
@LeonardoVieira1630 LeonardoVieira1630 added the documentation Improvements or additions to documentation label Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant