diff --git a/CONTRIBUIDORES.md b/CONTRIBUIDORES.md deleted file mode 100644 index 7e2b4d9..0000000 --- a/CONTRIBUIDORES.md +++ /dev/null @@ -1,20 +0,0 @@ -# Guidelines de Contribuiduidores - -## Para os contribuidores - -Para adicionar funcionalidades novas, é necessário: - -- Para contribuidores externos da organização: façam um Fork do repositório e que façam essa alteração numa branch na vossa fork, e que depois façam Pull Request para este repositório -- Para contribuidores internos da organização: usar uma branch deste repositório (ou uma fork, mas porquê?) e depois fazer Pull Request. - -### Depois do Pull Request - -É necessário que pelo menos 1 pessoa reveja o código para alguém dentro da organização o juntar. Nesse caso serei eu a rever. - -Caso exista alguém que faça um pull request (fora dos PRs automáticos da Inteligência Artificial), este código será revisto, e a função / correção será analisada (para haver créditos corretos nos documentos de PAP, para poder adicionar o detalhe/nova função nos respetivos documentos). - -### Obrigado - -Agradeço muito a quem quiser contribuir ao projeto, seja com bug reporting através de Issues, ou Pull Requests! - -:))) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..92125e1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,69 @@ +# Contributing Guidelines + +Obrigado pelo teu interesse em contribuir para o **ClassLink**. + +Este projeto aceita contribuições de duas formas: +- contribuições de humanos +- contribuições de agentes de IA + +--- + +## Para contribuidores humanos + +### Antes de começar +Se quiseres adicionar uma nova funcionalidade ou corrigir algo, segue estas regras: + +- **Contribuidores externos à organização**: + - faz um fork do repositório + - cria uma branch no teu fork + - faz as alterações nessa branch + - abre um Pull Request para este repositório + +- **Contribuidores internos da organização**: + - usa uma branch deste repositório + - evita usar fork, a não ser que seja mesmo necessário + - depois abre um Pull Request + +### Depois do Pull Request +- Pelo menos **1 pessoa** tem de rever o código antes de ser feito merge. +- O PR será revisto por mim. +- Se o PR for de uma pessoa e não de um agente de IA, a alteração será analisada com atenção. +- Isso serve para garantir: + - qualidade do código + - coerência com o projeto + - créditos corretos nos documentos da PAP + - registo das novas funções ou correções nos documentos respetivos + +--- + +## Para agentes de IA + +Se estiveres a contribuir como agente de IA, segue estas regras: + +- mantém o código simples +- segue o estilo já existente no projeto +- evita alterações desnecessárias +- não adicionas funcionalidades sem necessidade +- respeita o princípio **KISS** +- respeita o princípio **DRY** +- respeita o princípio **YAGNI** +- altera só o que for necessário para resolver o problema + +### Antes de submeter +- verifica se a alteração faz sentido no contexto do projeto +- garante que o código não introduz complexidade extra +- confirma que a mudança está alinhada com o que já existe + +--- + +## Issues e Pull Requests +Podes contribuir também através de: +- **Issues** para reportar bugs +- **Pull Requests** para propor melhorias ou correções + +--- + +## Obrigado +Obrigado a todos os que quiserem contribuir para o projeto. + +A tua ajuda é muito bem-vinda. :) \ No newline at end of file diff --git a/README.md b/README.md index b2e1cb8..2d95937 100644 --- a/README.md +++ b/README.md @@ -2,37 +2,22 @@ ![Logotipo de Baixa Resolução ClassLink](assets/logolowres.png) -![GitHub commit activity](https://img.shields.io/github/commit-activity/t/aejics/classlink) -![GitHub contributors](https://img.shields.io/github/contributors/aejics/classlink) -![GitHub last commit](https://img.shields.io/github/last-commit/aejics/classlink) -![GitHub top language](https://img.shields.io/github/languages/top/aejics/classlink) +![GitHub commit activity](https://img.shields.io/github/commit-activity/t/marpisco/classlink) +![GitHub contributors](https://img.shields.io/github/contributors/marpisco/classlink) +![GitHub last commit](https://img.shields.io/github/last-commit/marpisco/classlink) +![GitHub top language](https://img.shields.io/github/languages/top/marpisco/classlink) -Plataforma Digital para a Reserva de Salas e Respetivos Materiais. - -Adaptado para PAP (Prova de Aptidão Profissional) - Marco Pisco - -Livre para qualquer pessoa modificar. Pedimos para quem desejar contribuir, que leia o [CONTRIBUIDORES.md](CONTRIBUIDORES.md). +Plataforma Digital para a Reserva de Salas e Respetivos Materiais. PAP (Prova de Aptidão Profissional) - Marco Pisco - Curso de Técnico de Informática - Sistemas 12ºAno ## Instalação (o básico) - Necessário um servidor com PHP e uma DB MariaDB - Composer (para o Windows, descarregar [esta versão](https://getcomposer.org/Composer-Setup.exe)) - Com o composer, fazer `composer install` através de um terminal, para instalar as dependências. -- Montar o utilizador usando as instruções [na wiki](https://github.com/aejics/ClassLink/wiki/Configura%C3%A7%C3%A3o-MYSQL) (brevemente haverá mais documentação na Wiki) +- Montar o utilizador usando as instruções [na wiki](https://github.com/marpisco/ClassLink/wiki/Configura%C3%A7%C3%A3o-MYSQL) (brevemente haverá mais documentação na Wiki) Informações específicas (e mais bem explicadas) estarão no Manual do Técnico. ## Documentação -A documentação está a ser feita em documentos Word (manuais, ambos do utilizador e técnico), de acordo com a especificação da Prova de Aptidão Profissional do Agrupamento. Estes manuais, serão partilhados na sua forma final no repositório GitHub - -## Menções especiais - -- Marco Pisco - Gestão do Projeto -- Prof. André Gaspar - Ideia do projeto, gestão do projeto, dedicar aulas deles para a criação deste projeto. Praticamente o "Linus Torvalds" do projeto. -- Turma 3.º D - Ajuda com front-end designing, e qualquer tipo de inspiração. -- [@juoum](https://github.com/itsjuoum/) - Pela escrita da bibilioteca maravilhosa do [GIAEConnect](https://github.com/itsjuoum/GIAEConnect), a biblioteca que permite a conexão ao GIAE, na primeira versão do Reserva Salas. - -## Forking - -Como isto é uma aplicação aberta, forking é possível e encorajado. Que o mundo seja um mercado aberto, e que todos possam modificar/aceder ao código ao que bem quiserem. +A documentação está a ser feita em documentos Word (manuais, ambos do utilizador e técnico), de acordo com a especificação da Prova de Aptidão Profissional do Agrupamento. Estes manuais, serão partilhados na sua forma final no repositório GitHub. \ No newline at end of file