O framework visa facilitar o desenvolvimento de aplicações e jogos 2D feitos em Javascript. Reduzindo a dificuldade e simplificando o processo de criação de jogos utilizando de métodos que cria objetos, define físicas, e correlaciona controles. Ademais, oferece templates para que o usuário possa criar seu próprio formato de objeto.
Para a utilização do framework basta inserir o trecho de código em HTML dentro de seu projeto. Assim, todas as nossas funcionalidades estarão prontas para uso.
<script src="https://rawgit.com/Desenho-1-2018-G-6/gamid/master/dist/gamid.js"> </script>Possuímos dois tipos de documentação. Uma documentação voltada para a parte mais técnica que parte da elicitação até a implementação dos requisitos. E uma segunda documentação que é sobre a utilização do Gamid.
Utilizamos a wiki do próprio GitHub para a documentação mais técnica. Ademais, utilizamos o GitHub-pages para a documentação de utilização da aplicação.
- Documentação técnica do framework: https://github.com/Desenho-1-2018-G-6/gamid/wiki
- Documentação sobre a utilizaço do Gamid: https://gamid-gh-pages.herokuapp.com/
- Repositório da documentação sobre a utilização: https://github.com/Desenho-1-2018-G-6/gamid-pages
Existem duas maneiras pelas quais você pode contribuir para este repositório:
- Melhorando a documentação
- Trabalhando no backend framework
Escolher o que trabalhar em um projeto de código aberto não é fácil. Nem todas as alterações ou recursos que resolvem uma coceira pessoal serão mesclados no repositório principal. Alguma comunicação antes do tempo pode ser sábia. Se a sua adição criar um novo recurso ou configuração, ou alterar de alguma forma a maneira como as coisas funcionam de maneira substancial, lembre-se de enviar uma solicitação de recepção correlata para documentar suas alterações na documentação.
De modo geral, todo código novo gerado como feature necessitará passar pelas duas fases de contribuição, tanto no código, quanto na contribuição da documentação de utilização.
Para ambos os tipos de contribuição, trabalharemos com um fork do projeto.
Abaixo estão as diretrizes para trabalhar em solicitações de Merge Requests:
- 4 níveis de identação
- Nenhum erro de ortografia
- Nenhum erro sintaxe de Markdown
- Escrita detalhada do que está propondo
- Javascript
- Git
A base de código não é perfeita, no momento da escrita, mas espera-se que você não introduza novas violações de estilo de código.
Na medida do possível, verifique suas alterações. No melhor dos casos, adicionando novos testes ao conjunto de testes. No mínimo, executando as alterações via navegador e verificando-o manualmente.
Se seu código tiver erros de sintaxe que não permitirão sua execução, é um bom sinal que a solicitação de recebimento ainda não está pronta para envio.
| Nome | GitHub |
|---|---|
| André Bedran | @affbedran |
| Ateldy Brasil Filho | @ateldyfilho |
| Guilherme Augusto | @guiaugusto |
| Guilherme Lacerda | @guilacerda |
| Lucas Malta | @lucasssm |
| Lucas Martins | @MartinsLucas |
| Thalisson Melo | @ThalissonMelo |