opendevufcg / glossario-ufcg Goto Github PK
View Code? Open in Web Editor NEWGlossário contendo significados de siglas e gírias usadas por alunos da UFCG.
Home Page: https://glossario.opendevufcg.org
License: MIT License
Glossário contendo significados de siglas e gírias usadas por alunos da UFCG.
Home Page: https://glossario.opendevufcg.org
License: MIT License
Atualmente o webpack não está atualizando automaticamente a página ao alterar algum CSS em modo de desenvolvimento.
Descreva o bug
Quando é pesquisado um termo que não existe, é exibido uma página vazia
Reprodução do bug
Acessar https://glossario.opendevufcg.org/#/aksjdlka
Comportamento desejado
Talvez fosse interessante mostrar uma mensagem de resultado não encontrado
Acredito que o nosso arquivo de dados que contém os significados está crescendo bastante e não teremos um bom controle se crescer mais. Gostaria de sugerir a correção do formato para que fosse utilizado uma lista em ordem alfabética para evitar duplicações e retrabalho.
Descrição da melhoria:
Os Links "Como Contribuir" e "Quem Somos" podem ter um efeito de hover simples e minimalista.
Necessidade da melhoria: Melhorar o design da página e passar melhor a impressão que é "clicavel"
Como ela pode ser implementada: Talvez um efeito que mude um pouco a cor para mais clara ou escura
É uma das maiores prioridades atualmente, acredito que a maioria dos usuários acessará pelo celular. 🤔
Descrição da melhoria:
Quando passar o mouse no termo que aparece em "Você sabe o que é ..." era bom adicionar algum efeito ao passar o mouse por cima (hover)
Necessidade da melhoria: para passar melhor a impressão de clicável
Como ela pode ser implementada:
Talvez sublinhá-lo ao passar o mouse
Descrição da melhoria:
Muitas das coisas que fazemos podem ser auxiliadas com links. Tendo isso em vista, é interessante adicionar um suporte à Markdown ou HTML nas descrições.
Necessidade da melhoria:
A melhoria é necessária pois, por exemplo, ao adicionarmos lugares (blocos, por exemplo), é interessante adicionarmos links para o google maps indicando a localização. Essa é apenas uma necessidade inicial, e por ajudar bastante os feras, tem grande importância.
Como ela pode ser implementada:
É possível implementar facilmente através do uso do React Markdown ou similares
Descrição da melhoria:
Botão de pesquisa poderia ser usado para procurar em todos os termos.
Necessidade da melhoria:
Atualmente o botão de pesquisa não apresenta funcionalidade.
Como ela pode ser implementada:
Criação de um filter na lista de acronimos com o resultado do input.
Atualmente os dados do data.js estão acumulando siglas, blocos, gírias, disciplinas, etc numa só coleção. Porém, cada tipo de termo requer uma estrutura específica e essa abordagem também dificulta a contribuição... Por isso, qual seria a melhor forma de reestruturar esses dados?
Descrição da melhoria:
Separar melhor os componentes de acordo com suas Views e talvez melhorar os nomes dos componentes também.
Necessidade da melhoria:
A atual estrutura de diretório de componentes está confusa e será implementado novas páginas, o que torna ainda mais confuso. Se faz necessário em separar melhor os componentes e agrupá-los de maneira que faça sentido.
Como ela pode ser implementada:
Uma sugestão é a maneira que o Musicritic organiza seus componentes.
Criar uma nova configuração do webpack (webpack.prod.js
) com configurações de produção segundo os guidelines da documentação do react e configurar o script yarn build
para execução do build usando a nova configuração do webpack.
OBS: A configuração atual deve ser mantida para desenvolvimento.
Descrição da melhoria:
Extinguir falhas do lint.
Necessidade da melhoria:
Deseja-se usar a verificação do lint no travisCI, e, para não quebrar a pipeline, essas falhas devem ser corrigidas.
Como ela pode ser implementada:
A maioria dessas falhas está relacionada com a validação de props faltando, com isso, deve-se usar propTypes para validar isto.
Apesar de possuir o arquivo de Favicon no caminho assets/images/favicon.ico
, o favicon não é mostrado.
Bem, vamos começar com uma historinha... Inicialmente a gente pensava no glossário apenas como um site pra gente descobrir o que significa algumas siglas do curso de computação... porém com o tempo a gente viu que tem muitos outros termos que poderíamos adicionar como gírias da universidade e etc. Por causa disso, maioria dos nossos dados continham apenas a sigla e o que ela significa "por extenso" por exemplo: P1 -> Programação 1 e etc...
Percebemos depois que algumas siglas não fazem tanto sentido se apenas dissermos o que ela significa por extenso, precisamos dar uma descrição mais detalhada... por exemplo:
P1 -> Programação 1 -> Disciplina do 1º período de ciencia da computação que [...]
Um texto curtinho apenas para ficar claro para o leitor do que se trata o termo.
Também precisamos adicionar aplicações em frases para todos os termos que já temos, conforme o padrão na nossa documentação dos dados (nessa parte pode esquecer a seriedade e tentar ser engraçadinho, mas sem desrespeitar ninguém taokei?).
[EDIT] Se você caiu nessa issue antes de ver nosso README, seria uma boa dar uma olhada no nosso CONTRIBUTING.md pra ver como a gente organiza os dados e etc... Se tiver problemas com git ou com qualquer outra coisa sobre como ajudar nessa task, pode falar com a gente no gitter que a gente te ajuda!!!
[EDIT2] Podem seguir o padrão do PR #47
Segue abaixo a lista de termos que ainda estão faltando esses dados:
Para a descrição das disciplinas não precisa de muita informação, basta informar qual período ela é ofertada, se é obrigatória ou optativa, se existe com outro nome na nova grade ou na grade antiga... essas curiosidades pequenas só pra contextualizar.
Nas gírias, elas só precisam basicamente de mais aplicações em frases, mas se quiserem adicionar mais informações sobre o porquê de usar essa gíria, ou de onde ela surgiu... é muito bem vindo!!!
Nas descrições dos locais seria bom ter informações de o que é o local, em que bloco fica por exemplo, ou coisas do tipo "na frente da biblioteca"... e etc, futuramente pensamos em adicionar coordenadas e mostrar um mapa como foi dito na issue #18 mas são cenas dos próximos capítulos....
Nesses eu peço pra tentarem ser o mais descritíveis o possível, pois não temos uma categorização por tipo bem definida, o que complica um pouco mais o entendimento sobre que se trata o termo
VALENDO!!!!!!!!
Ao pesquisar um termo, ele deveria colocar em https://opendevufcg.github.io/glossario-ufcg/<termo>
, mas ao invés disso ele faz https://opendevufcg.github.io/<termo>
e retorna erro 404.
Foi levantado o tópico sobre ter mais informações, de modo que ao mostrar o que a sigla significa, mostrar também uma breve explicação sobre o que é. Além disso, modificações para incluir hiperlinks levando à mapas, para o exemplo de siglas de blocos (e.g. CAA), devem também ser feitas.
Descrição da melhoria:
Adicionar links externos nos termos já existentes, quando possível.
Necessidade da melhoria:
Alguns dos nossos termos se referem à outras comunidades dentro de CC@UFCG: Elas, Caesi, Guardians, etc. Desse modo, seria interessante linkar os perfis e/ou páginas das outras comunidades aqui no glossário, facilitando assim o acesso às informações mais recentes das outras comunidades, e também atuando como uma divulgação.
Como ela pode ser implementada:
Se bem me recordo, renderizamos os textos do glossário com Markdown. Assim, é necessário apenas editar as descrições desses termos, incluindo links.
Contexto adicional:
Talvez seja interessante consultar alguém que faça parte desses grupos para entender o melhor link, perfil, ou rede social a ser linkado. Além disso, pode ser linkado mais de um perfil, caso o texto não fique excessivo.
Descrição da melhoria:
O usuário disse que entendeu que a intenção é você entrar e pesquisar o termo, mas ele sentiu a necessidade de dar a experiência de navegação e conhecer a plataforma, no caso poder clicar em termos e ver significados.
Necessidade da melhoria:
Sugeriu uma listagem de termos onde o usuário possa clicar e veja o significado, dessa forma ele pode ver como a plataforma funciona e ser exploratório.
Como ela pode ser implementada:
Uma listagem de todos os termos, talvez separado por categorias, onde o usuário clica e mostra o significado.
Descrição da melhoria:
Permitir acesso às páginas independente se o termo foi escrito idêntico à entrada ou não.
Necessidade da melhoria:
Atualmente, é possível acessar diretamente o significado de um termo por sua URL, a exemplo de https://glossario.opendevufcg.org/#/SO. Entretanto, caso seja digitado o SO em minúsculo na URL (https://glossario.opendevufcg.org/#/so), somos redirecionados para a página de 404, quando o comportamento desejado é ser redirecionado para a mesma página.
Como ela pode ser implementada:
Pode ser corrigida adicionando um toLowerCase
ao recuperar o termo.
Pessoal, as optativas gerais não vão ser adicionadas?
[EDIT]
A seguinte lista de optativas gerais não está ainda no glossário:
(Se alguma das disciplinas listadas não for uma optativa geral, ou não fizer sentido estar aqui, comente abaixo)
Adicionar termos pedidos por @pedroespindula na #77
Descrição da melhoria:
Seria legal nossos componentes terem um formato mais funcional, tornando-os mais intuitivos e para ajudar com isso, o React provê as hooks
Descrição da melhoria:
Não sei se deveria existir uma utilidade pra esse arquivo, mas atualmente ele é vazio, e é importado apenas no index.
Descrição da melhoria:
Renomear o componente para TermCard
e fazer ele customizável, tendo props de tamanho e estilo.
Necessidade da melhoria:
O card pode ser usado para outros contextos além da página de resultados da pesquisa.
Como ela pode ser implementada:
Criar props para tamanho, e se preciso de estilo também. Definir os tipos possíveis, e talvez usar proptypes
.
Descrição da melhoria:
Colocar link do site no README do repositório.
Necessidade da melhoria:
Para dar mais visibilidade ao site.
Descrição da melhoria:
Algumas pessoas apenas querem sugerir a adição de um termo para que outra pessoa adicione nossos dados. Seria interessante criar um issue template especial para esse tipo de request, que a pessoa preencha direitinho esses campos:
Fork, PR, Issue, Commit (e outros que acharem interessantes)
Esses termos foram solicitados por feras que procuraram no glossário alguns termos que acharam nos nossos readmes e não encontraram... Seria mto bom ter eles aqui
Descreva o bug
Enquanto o script de pre-commit estava implementado em python, ele ordenava os dados antes do commit. Entretanto, após ser refeito em Node, agora os dados alterados pelo script não são incluídos no commit
Reprodução do bug
Passos para reproduzir o comportamento indesejado:
src/lib
) de forma a alterar a ordem alfabética de um dos arquivosComportamento desejado
Era desejado que o script de reordenação adicionasse as alterações que ele mesmo fez nos dados.
Capturas de tela
Se aplicável, adicione capturas de tela para ajudar na descrição do problema
Desktop:
Descrição da melhoria:
Refatorar codigo para não haver duas paginas separadas. Atualmente existe a pagina de resultados e a home do glossario.
Necessidade da melhoria:
Evitar codigo duplicado e facilitar a manutenção futuramente.
Como ela pode ser implementada:
A partir de propriedades css pode-se esconder e mostrar os resultados da pesquisa num container.
O travis não está rodando o lint, é preciso configurar pra rodar o comando yarn run lint
. Acompanhado dessa task tem que resolver os erros já existentes.
Seria legal criar uma listinha dos types existentes (com a definição do que ele contém) e como definir novos types... Por exemplo, pra colocar PRE no data.js, qual seria o type adequado?
Algumas siglas usadas na UFCG tem mais de um sentido. P1, por exemplo, pode ser usada tanto para se referir a cadeira de programação 1, como também sobre a cadeira de Projeto 1, assim como o primeiro periodo do curso.
A documentação de termos novos no CONTRIBUTING.md
está muito rasa, é preciso documentar melhor como fazer, os tipos existentes, como um termo pode ser um array de vários objetos e etc.
Descrição da melhoria:
Atualmente, nós nao temos um componente para o header, isso é feito via css, dependendo do que a pagina possui.
Como ela pode ser implementada:
Criar um componente Header
que só sera exibido, nos componentes em que foi incluido ou a partir de determinada rota.
Descrição da melhoria:
No arquivo README.md
, possui o seguinte:
Sinta-se livre para reportar erros, tirar dúvidas, dar sugestões e mandar mensagens bonitinhas pra gente nas issues heart e não esquece de entrar no nosso channel no gitter pra conversar com a gente!!
Ao invés de nosso canal no gitter, colocar nosso canal no Discord, com o devido link.
Necessidade da melhoria:
Não utilizamos mais o Gitter, e as pessoas poderiam achar que ainda estamos por lá e que serão respondidas.
Como ela pode ser implementada:
Trocar o texto para nosso canal no Discord e alterar o link.
Seria bom ter um ícone pequeno do Github no bottom da página que redirecionasse pro repositório. O que acham?
Atualmente o Glossário está dando suporte aos significados diretos das siglas comumente usadas em ciência da computação na UFCG, porém parte dos termos que os feras não costumam conhecer são gírias e expressões como: bola, leite, tamburete, pijama e etc.
Acredito que não precisaríamos modificar nossa estrutura atual para adicionar isso, porém seria interessante adicionar um atributo que tivesse exemplos de aplicação em frase daquelas expressões para facilitar o entendimento da expressão
LSD, SPLab...
Laboratório de Sistemas Distribuídos, Software Practices Laboratory...
Laboratórios dentro da UFCG
"A aula de P1 hoje será no SPLab."
"A sala da professora Lívia fica no LSD"
Em termos que são locais, posso adicionar sua localização no google maps através de um link?
Exemplo: LCC3 -> https://goo.gl/maps/AvG7MYGsqZ92
Fera
Novo aluno no curso.
Termo geralmente usada para designar novos alunos nos cursos de faculdade.
"Andando pelos corredores sorrindo? Só pode ser fera..."
Descrição da melhoria:
A maioria dos termos do tipo local
não possui uma localização. A melhoria é adicionar a esses termos essa localização.
Necessidade da melhoria:
Facilitar a identificação e acesso do local pelos estudantes.
Como ela pode ser implementada:
Seguir o modelo implementado no termo LCC1
, que usa de um link no maps para mostrar a localização. Esse link é usado como um link comum em MarkDown, ou seja:
[nome do link](https://link.com)
Para descobrir o link da localização, vá no google maps e procure pela UFCG. Ao encontra-la procure pelo local a qual você quer conseguir a localização e ao encontra-lo clique nele. Esse será o link da localização.
Imagens:
Descrição da melhoria:
Incluir categoria de estabelecimento nos termos, talvez incluindo também o link do Google maps.
Necessidade da melhoria:
Estabelecimentos como xerox e restaurantes são úteis para novatos na Universidade que não conhecem.
Como ela pode ser implementada:
Adição do termo no json dos dados e adição de campo google maps.
Descrição da melhoria:
Seria legal incluir os tipos esperados das propriedades que sao passadas para os componentes
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.