Softwares open source servem para criar um ambiente de aprendizado diverso, em que é possível aprender , ensinar e criar experiência em qualquer habilidade.
Existem diversas formas de contribuir para um software open source, seja no código , documentação , organização , design, entre outros. para contribuir para o nosso projeto, primeiramente leia o código de conduta encontrado aqui
no nosso projeto são utilizadas as seguintes ferramentas para desenvolvimento do projeto:
- Issue tracker: onde as pessoas discutem tarefas e problemas relacionadas ao projeto
- Pull requests: onde as pessoas discutem e revisam as mudanças que estão em progresso
Antes de criar uma issue ou pull request , é necessário:
- comunicar suas inteções e suas ideias de forma efetiva, mostrando o que deseja fazer, o contexto por trás da idéia , e a utilidade dela para o projeto
- olhar o README encontrado aqui , as issues abertas e fechadas, e outros canais de comunicação da comunidade
É necessario abrir uma issue nas seguintes situações:
- Relatar um erro que você não consegue resolver sozinho
- discutir um tópico ou idéia de alto nível (visão da comunidade , políticas da comunidade, entre outros)
- propor uma nova feature ou uma ideia de projeto
para criar uma issue de acordo com o padrão do projeto , olhe o template das issues encontrado aqui
- no caso de uma issue que deseja resolver , comente na issue para que outros possam saber que está trabalhando nela
- se uma issue foi aberta muito tempo atrás , é possível que ela esteja sendo resolvida em outro lugar ou já tenha sido resolvida, então é necessário comentar nela para pedir confirmação antes de começar a trabalhar
- se você abriu uma issue e descobriu como resolver ela depois , comente na issue e feche ela depois , para que outros possam saber que elá já foi realizada.
É necessário abrir um pull request nas seguintes situações:
- enviar correções triviais (um link quebrado , um erro simples e óbvio, entre outros)
- começar a trabalhar em uma contribuição que já foi pedida ou discutida através de uma issue
Vale destacar que um pull request não precisa representar um trabalho finalizado. geralmente é melhor abrir um pull request no começo do desenvolvimento , para outros oferecerem feedback no seu progresso. Para isso , basta abrir ele como "draft" ou marcar ele como "WIP" (trabalho em progresso). é sempre possível adicionar commits depois
- clone o repositório localmente, realize um pull para manter no estado atual do repositório
- crie uma branch para suas modificações
- referencia alguma issue relevante ou documentação auxiliar para seu pull request (como por exemplo "fechando #21")
- se seu pull request for relacionado a HTML/CSS, inclua imagens de antes e depois para comparação
- teste suas modificações para não realizar mudanças prejudiciais ao projeto
- contribua com o estilo do projeto da melhor forma possível , com os padrões e parâmetros já existentes
para criar um pull request , utilize o template de pull request do projeto
Open source software serves to create a diverse learning environment where it is possible to learn, teach and create experience in any skill.
There are several ways to contribute to open source software, whether in code, documentation, organization, design, among others. to contribute to our project, first read the code of conduct found here
In our project, the following tools are used for project development:
- Issue tracker: where people discuss tasks and issues related to the project
- Pull requests: where people discuss and review changes that are in progress
Before creating an issue or pull request , you need to:
- communicate your intentions and ideas effectively, showing what you want to do, the context behind the idea, and its usefulness for the project
- look at the README found here , the [issues](https://github.com /fga-eps-mds/2022-2-Squad03/issues) open and closed, and other community communication channels
It is necessary to open an issue in the following situations:
- Report a bug that you can't resolve yourself
- discuss a high-level topic or idea (community vision, community policies, etc.)
- propose a new feature or a project idea
to create an issue according to the project pattern, look at the issues template found [here](https://github.com/fga-eps-mds/2022-2-Squad03/blob/devel/.github/ISSUE_TEMPLATE .md)
- in the case of an issue that you want to resolve , comment on the issue so that others can know that you are working on it
- if an issue was opened a long time ago , it is possible that it is being resolved elsewhere or has already been resolved, so you need to comment on it to ask for confirmation before starting work
- if you opened an issue and found out how to solve it later, comment on the issue and close it later, so others can know that it was already done.
It is necessary to open a pull request in the following situations:
- submit trivial corrections (a broken link, a simple and obvious error, and so on)
- start working on a contribution that has already been requested or discussed via an issue
It is worth noting that a pull request does not have to represent a finished job. It's usually best to open a pull request early in development, for others to provide feedback on your progress. To do this, just open it as "draft" or mark it as "WIP" (work in progress). it is always possible to add commits later
- clone the repository locally, pull it to keep the current state of the repository
- create a branch for your modifications
- references any relevant issue or supporting documentation for your pull request (such as "closing #21")
- if your pull request is related to HTML/CSS, include before and after images for comparison
- test your modifications to not make harmful changes to the project
- contribute to the style of the project in the best possible way, with the already existing standards and parameters
to create a pull request, use the pull request template from the project