Com o intuito de gerenciar as informações utilizadas em projetos do condomínio, foi criada a organização Recreio Canoas, utilizando uma ferramenta totalmente gratuita que gerencia repositórios de dados acessíveis a todos. Para ter acesso às informações, basta consultar os links mostrados a seguir.
- Organização Recreio Canoas
- Como participar
- Para saber como usar os repositórios de dados, veja este treinamento.
Essa iniciativa incentiva você a dedicar alguns minutos da semana para contribuir online para o conteúdo do site. Através da Internet, você poderá participar na medida do possível, no momento possível e na quantidade disponível para a ocasião.
Em troca, a organização poderá realizar projetos para o condomínio unindo a sabedoria e inteligência que hoje está distribuída por todos mas não aproveitada adequadamente. Além de potencializar nossos projetos, você poderá ainda exercitar o mesmo workflow usado hoje em empresas gigantes de software do planeta. São essas empresas que mais crescem hoje em dia, no ambiente dinâmico da tecnologia da informação.
Veja mais detalhes de como contribuir online.
Para quem não conhece, o Github é um site que gerencia a confecção de programas de computador. Com 28 milhões de usuários e 85 milhões de repositórios, é o maior serviço de gerenciamento de código fonte do planeta. Foi comprado recentemente pela Microsoft por $8.5 bilhões de dólares e seu uso permite que pessoas espalhadas por todo o mundo colaborem em projetos de software, em um processo eficiente e versátil. O site dispõe de mais informações sobre os tipos de conta de usuário e de organização.
Ocorre que um programa nada mais é que um texto, ou seja, podemos (sub)utilizar o Github para editar apenas textos, imagens e tabelas, como esse que vocês estão lendo. Para atingir nossos objetivos e melhorar o condomínio, não vamos precisar usar todas as funções do Github, apenas de um treinamento simplificado. Com isso, já seremos capazes de criar, debater, alterar e aprovar textos em diversas pautas simultâneas sobre assuntos diversos que envolvem o nosso dia a dia.
Nota: O Github é escrito em, inglês. Contudo, utilizando o navegador Chrome, pode-se traduzir o site para português, bastando clicar o botão direito do mouse e selecionar a opção de tradução, como indicada abaixo. A partir daí, a navegação é mantida em português, apesar de alguns termos ficarem meio estranhos. A princípio, poderão ser mencionados comandos em inglês,
marcados desta formapara diferenciar.
A ideia é convidar os condôminos a se tornarem membros da organização Recreio Canoas.
A razão dessa iniciativa é facilitar a cooperação em projetos do condomínio. Normalmente, a maior dificuldade tem sido reunir as pessoas em um mesmo local, em uma mesma hora. Essa iniciativa irá permitir que você possa dedicar algumas horas para trabalhar conforme sua vontade e disponibilidade, utilizando sua vocação e capacidade para contribuir em projetos diversos do condomínio.
Podemos convidar qualquer pessoa para se tornar um membro da organização, usando o seu nome de usuário do Github ou endereço de e-mail. Os colaboradores podem incluir membros da organização ou colaboradores externos.
Um colaborador externo é uma pessoa que tem acesso a um ou mais repositórios de organização, mas não é explicitamente um membro da organização. Um colaborador externo tem acesso apenas aos repositórios a ele permitidos.
Para tomar conhecimento do conteúdo não é necessário ser um membro da organização. Contudo, se você tem interesse em colaborar na geração de conteúdo do site, por favor procure a administração do condomínio, informe seu e-mail e receba o convite para se tornar um membro.
A pessoa sendo um membro explícito da organização poderá:
- Alterar o conteúdo publicado
- Criar equipes
- Ver todos os membros e equipes da organização
- Fazer @menção a qualquer time visível
- Ser um mantenedor de equipe
Agrupando membros da organização em equipes pode-se refletir a estrutura de grupos de trabalho e definir mais facilmente as permissões de acesso aos repositórios. Além disso, pessoas com permissões de mantenedor podem adicionar membros da organização à equipe.
Os membros da organização podem solicitar para participar de qualquer equipe, basta que um responsável pela equipe aprove a solicitação. Existe ainda a facilidade de se fazer @menções para toda a equipe, por exemplo, @recreiocanoas/consultivo em qualquer comentário, questão ou solicitação. Desta forma, todos os membros da equipe serão automaticamente notificados.
O processo de contribuição dos colaboradores tem por objetivo evoluir os repositórios da Organização Recreio Canoas. Os diversos colaboradores, distribuídos em equipes, podem trabalhar simultaneamente em diversos assuntos de interesse do condomínio. O ciclo do processo pode ser visto no diagrama a seguir.
É o repositório propriamente dito. A organização poderá ter vários repositórios, com finalidades diversas, a serem definidas por nós mesmos. Por definição do processo, sempre existirá a versão oficial do repositório em um ramo (branch) chamado de mestre (master).
O REPO é composto de diversos arquivos texto, por exemplo, o repositório em que estamos agora foi chamado de docs e o arquivo chama-se readme.md. Basta navegar na organização Recreio Canoas para verificar que, a princípio, foram criados 3 repositórios: docs, radar e consultivo. A ideia preliminar é que eles seriam usados da seguinte forma:
- docs: conteria explicações, treinamentos e informações sobre esse processo.
- radar: seria um local para os condôminos proporem seus projetos e ideias.
- consultivo: seria uma forma de comunicação da administração do condomínio.
Reparem que toda pasta (folder) pode ter um arquivo readme.md que é renderizado automaticamente pelo Github. Devemos portanto utilizá-lo para facilitar a navegação pelo site.
Suponha agora que seja iniciado um trabalho por uma pessoa ou equipe, com o objetivo de incluir ou alterar as informações contidas em um REPO. Para isso, deverá ser criado um novo RAMO (branch) especialmente para a mudança que será realizada. Após as mudanças serem concluídas, a pessoa e/ou equipe de trabalho deve fazer uma solicitação de pull (pull request), quando então será iniciada a avaliação do RAMO de mudança.
A mudança do REPO não é imediata, dando à comunidade a possibilidade de participar da discussão sobre a mudança proposta pelo RAMO (ou branch) de mudança. Com isso, dependendo do caso, podem ocorrer diversas situações:
-
As mudanças contidas no RAMO são aceitas pela comunidade. Nesse caso, prossegue-se fundindo (
merge) as alterações propostas, ou seja, as mudanças propostas pelo RAMO se incorporam ao REPO, passando a fazer parte do repositório. No diagrama, completa-se o ciclo azul, onde o REPO é alterado e o RAMO de mudança pode até ser apagado, pois não tem mais utilidade. -
Se a comunidade (ou quem deve aprovar) tem ressalvas sobre as mudanças propostas pelo RAMO, há possibilidade de se questionar, debater e alterar, até que sejam satisfeitos todos os requisitos. Nesse caso, a pessoa ou equipe continua a trabalhar no RAMO. Nada impede que mais pessoas venham a se juntar no esforço de continuar o aprimoramento da mudança. Todo esse debate é realizado no âmbito do
pull request, pois o Github tem os recursos com essa finalidade. -
Reparem que nesse processo também é perfeitamente normal que o RAMO de mudança seja recusado, ou seja, o RAMO de mudança pode ser simplesmente apagado. Nesse caso, é mantido o conteúdo original do REPO, contido no RAMO mestre.
-
Aliás, quanto mais cedo for iniciada a solicitação de pull (
pull request) melhor! Se uma mudança não está indo no caminho certo, é melhor encerrá-la o quanto antes, na tática conhecida como "kill the baby", em que se evita perder tempo com retrabalhos de grande porte. -
Reparem que no interesse de promover um ambiente aberto e acolhedor, nós, como colaboradores e mantenedores, comprometemo-nos a tornar a participação em nosso projeto e em nossa comunidade uma experiência livre de assédio para todos. Veja um modelo de Código de Conduta do Pacto de Contribuinte.
Nota: Você também poderá transferir todo o conteúdo do RAMO para trabalhar localmente no seu microcomputador. Nesse caso, ao final de cada ESTÓRIA, pode-se salvar o conteúdo local do RAMO, do seu micro para o site Github, através da operação
push. Mas o processo simplificado atual não irá necessitar dopush.
Para organizar o trabalho de um RAMO de mudança, sugere-se utilizar uma sequência de ESTÓRIAS. Cada ESTÓRIA representa uma fração do trabalho, atribuída a um membro ou equipe. Não há comando específico para se iniciar uma ESTÓRIA, é um mero artifício para organização do trabalho.
A princípio, o processo simplificado utiliza única e exclusivamente o navegador Internet. Para melhor experiência, sugere-se usar o Google Chrome.
Suponha agora que a ESTÓRIA (ou tarefa a ser realizada) implica na alteração do texto de um arquivo do REPO ou na inclusão/exclusão de um arquivo. Afinal, é para isso que esse processo serve! Após a alteração, é utilizada a operação commit para registrar a mudança.
O Github é um site especializado em registrar mudanças, na forma de commits, com um tratamento de primeira classe:
- Basta dar um título ao
commit, para compor o histórico das mudanças realizadas por cada colaborador. - O
commitregistra as mudanças realizadas. Além do título que você usou, são armazenadas a data e autor da mudança. - De novo, é uma boa prática fazer pequenas mudanças de cada vez, a cada
commit. - Pode-se desfazer um
commit, apesar de esta ser uma operação mais avançada para vermos depois.
O GitHub oferece contas gratuitas para usuários e organizações que trabalham em projetos públicos. Dispõe também de contas pagas que oferecem repositórios privados ilimitados. Mais uma vez, saiba que:
- Você não precisa abrir uma conta no Github para ler os repositórios da organização Recreio Canoas.
- Você não precisa de uma conta paga para colaborar com os repositórios da organização Recreio Canoas.
- Para participar do conteúdo da organização Recreio Canoas, basta ter uma conta gratuita no Github.
Vá para a página de preços do GitHub.
- A página informa sobre as diferentes contas e planos que o GitHub oferece.
- Clique em
Inscreva-se em um dos nossos planos gratuitos. - Siga as instruções para criar sua conta pessoal.
O proprietário de uma organização pode promover qualquer membro da organização para o mantenedor da equipe de uma ou mais equipes. Clique em mantenedor de equipe para ver mais sobre:
- Alterar o nome e a descrição da equipe
- Alterar a visibilidade da equipe
- Definir a foto do perfil da equipe
- Editar discussões da equipe
- Excluir discussões da equipe
- Adicionar membros da organização à equipe
- Remover membros da organização da equipe
- Promover um membro da equipe existente para o mantenedor da equipe
Se você já abriu sua conta pessoal (e gratuita) no Github, passe para o próximo passo, para iniciar o treinamento rápido e simplificado do fluxo de trabalho que vamos utilizar.