Skip to content

document fixes, 01/04/2026#119

Merged
marpisco merged 2 commits intomainfrom
mpisco/doc-fixes
Apr 1, 2026
Merged

document fixes, 01/04/2026#119
marpisco merged 2 commits intomainfrom
mpisco/doc-fixes

Conversation

@marpisco
Copy link
Copy Markdown
Owner

@marpisco marpisco commented Apr 1, 2026

This pull request updates the project's contributor guidelines and documentation for clarity and consistency, and modernizes references to the repository's new organization. The main changes include replacing and improving the contributor guidelines, updating repository references throughout the documentation, and streamlining the README content.

Documentation and Guidelines Updates:

  • Added a new, more detailed CONTRIBUTING.md file, outlining clear instructions for both human and AI contributors, including contribution workflow, code review process, and project principles.
  • Removed the old CONTRIBUIDORES.md file, consolidating all contribution guidelines into the new CONTRIBUTING.md.

Repository Reference Updates:

  • Updated all repository references in README.md from aejics/classlink to marpisco/classlink, including badge URLs and documentation links.

README Streamlining:

  • Simplified the project description and removed outdated or redundant sections from README.md, such as "Menções especiais" and "Forking", to improve clarity and focus.

marpisco added 2 commits April 1, 2026 09:34
- Mudar o nome do ficheiro de CONTRIBUIDORES.md para CONTRIBUTING.md para os agentes de IA respeitarem o ficheiro,
- Adicionar Guidelines de contribuição para agentes de Inteligência Artificial, e adicionar Guidelines específicas a humanos
- alterar os badges para passarem a ter o novo link do repositório (org aejics removida, passou a fazer parte dos meus repositórios pessoais),
- atualizar link da wiki para corresponder ao link novo do repositório,
- corrigir a gramática que usei na parte da documentação (literalmente usar um ponto),
- remover menções especiais e informações de forking. as menções especiais devem ser feitas na pap, e são informações amais para colocar-se no readme de um projeto. as informações de forking aqui são desnecessárias pois as pessoas que queiram fazer forking devem consultar a licença do projeto.
@marpisco marpisco self-assigned this Apr 1, 2026
Copilot AI review requested due to automatic review settings April 1, 2026 08:39
@marpisco marpisco added the documentation Improvements or additions to documentation label Apr 1, 2026
Repository owner locked and limited conversation to collaborators Apr 1, 2026
@marpisco marpisco merged commit d6ba7db into main Apr 1, 2026
6 checks passed
@marpisco marpisco deleted the mpisco/doc-fixes branch April 1, 2026 08:43
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant