Skip to content

Latest commit

 

History

History
136 lines (84 loc) · 9.37 KB

CONTRIBUTING.md

File metadata and controls

136 lines (84 loc) · 9.37 KB

Welcome to GitHub Brasil contributing guide

Read in Portuguese

Boas vindas ao guia de contribuição do GitHub Brasil

Agradecemos por investir seu tempo em contribuir! As contribuições que você fizer no diretório website serão refletidas em githubbrasil.com ✨.

Suas contribuições ajudarão a comunidade a descobrir informações valiosas.

Leia nosso Código de Conduta para manter nossa comunidade acessível e respeitável.

Tipos de contribuição

No momento, aceitamos contribuições apenas para conteúdos selecionados no githubbrasil.com. O conteúdo para isso está localizado na seção website desse repositório.

Diretrizes

O site githubbrasil.com destina-se a mostrar o ecossistema de código aberto no Brasil e ajudar a descobrir projetos e pessoas mantenedoras de código aberto.

  • Somente nomes de repositórios, categorias de projetos, usernames do GitHub de pessoas mantenedoras e a localização dessas pessoas podem ser editados. Outras informações, como stargazes, descrições, seguidores etc., são atualizadas periodicamente na API pública do GitHub.
  • Para novas pessoas mantenedoras adicionadas, revisões de RP são solicitadas dessas pessoas para aprovação a serem adicionadas ao site.
  • O local da pessoa mantenedor precisa corresponder ao local em seu perfil público do GitHub.
  • Por favor, preencha o modelo de pull request completamente. Se você não preencher o modelo, seu PR vai ser fechado.
  • Limite seu PR a atualizar uma página por vez. Para atualizações de pessoas mantenedoras, limite a 5 em um PR.
  • Embora adoraríamos mostrar o maior número possível de projetos e pessoas mantenedoras, também queremos manter o site valioso para todas as pessoas desenvolvedoras. A equipe do GitHub usará seu julgamento e discrição nas aprovações de PRs.

Fazendo mudanças

Fazer mudanças de UI

Clique em Edit this page no topo de qualquer página que aceita contribuições. Isso vai te levar para um arquivo .yml onde você pode fazer suas mudanças e criar um Pull Request para review.

Fazer mudanças no Codespace

Você também pode faer mudanças usando o GitHub Codespaces. Para começar a usa-lo, veja "Guia de início rápido do GitHub Codespaces".

Fazer mudanças localmente

  1. Faça o fork (bifurque) este repositório.
  1. Crie uma branch de trabalho e comece suas mudanças!

  2. Commite as alterações quando estiver contente com elas.

Pull Request

Quando você terminar suas modificações, crie um Pull Request, também conhecido como PR.

  • Preencha o modelo para que possamos revisar seu PR (não esqueça de preencher todos os campos).
  • Habilite a caixa "Permitir edições de mantenedores" para que a branch possa ser atualizada para merge. Quando você submeter PR, alguém do time do GitHub vai avaliar sua proposta. Podemos fazer perguntas ou solicitar informações adicionais.
  • Nós podemos pedir para que mudanças sejam feitas antes de aceitar seu PR, usando alterações sugeridas ou comentários na Pull Request. Você pode aplicar as alterações sugeridas diretamente por meio da UI. Você também pode fazer outras mudanças no seu fork e commitá-las na branch.
  • Conforme você atualiza seu PR e aplica as alterações, marque cada conversa como resolvida.
  • Se você tiver qualquer problema, de uma olhada nesse git tutorial para te ajudar a resolver conflitos de merge e outros problemas.

Seu PR foi aceito!

Parabéns 🎉🎉! O time GitHub te agradece ✨.

As atualizações não aparecerão imediatamente depois do merge de seu PR. Colocamos essas alterações regularmente em githubbrasil.com.

Thank you for investing your time in contributing! Contributions that you make under the website directory will be reflected on githubbrasil.com ✨.

Your contributions would help the community discover valuable information.

Read our Code of Conduct to keep our community approachable and respectable.

Types of contributions

We currently accept contributions only for select content on githubbrasil.com. The content for this is located under the website directory of this repo.

Guidelines

githubbrasil.com website is intended to showcase the open source ecosystem in Brasil, and help discover open source projects and maintainers.

  • Only repository names, project categories, maintainer GitHub usernames, and maintainer locations can be edited. Other information like stargazers, descriptions, followers, etc are updated periodically from GitHub's public API.
  • For new maintainers added, PR reviews are requested from those maintainers for approval to be added on the website.
  • Maintainer locations need to match the location on their public GitHub profile.
  • Please fill out the pull request template completely. If you do not fill out the template, your pull request will be closed.
  • Please limit your pull request to updating one page at a time. For maintainer updates, please limit to 5 maintainers in a PR.
  • While we would love to showcase as many projects and maintainers as possible, we also want to keep the website valuable for all developers. GitHub team will use its judgement and discretion on PR approvals.

Making Changes

Make changes in the UI

Click Edit this page at the top of any page which accepts contributions. This takes you to the .yml file where you can make your changes and create a pull request for a review.

Make changes in a Codespace

You can also make a change using GitHub Codespaces. For getting started with Codespaces, see "Quickstart for GitHub Codespaces."

Make changes locally

  1. Fork the repository.
  1. Create a working branch and start with your changes!

  2. Commit the changes once you are happy with them.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill the Pull Request template so that we can review your PR.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a GitHub team member will review your proposal. We may ask questions or request for additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 The GitHub team thanks you ✨.

Updates won't immediately appear once we've merged your PR. We pull in these changes regularly to githubbrasil.com.