Pular para o conteúdo principal

Contribuir

👍🎉 Em primeiro lugar, obrigado por dedicar seu tempo para contribuir! 🎉👍

O Xplorer está atualmente em desenvolvimento. Estamos convidando contribuidores para colaborar com o Xplorer.

Participe#

Existem muitas maneiras de contribuir com o Xplorer, e muitas delas não envolvem a escrita de nenhum código. Aqui estão algumas idéias para começar:

  • Comece a usar o Xplorer! Passe pelos guias de tutoriais. Tudo funciona conforme o esperado? Caso contrário, estamos sempre em busca de melhorias. Informe-nos abrindo uma issue.
  • Dê uma olhada em issues do Xplorer . Se você encontrar um problema que gostaria de corrigir, abra um pull request. Problemas marcados como bom primeiro issue são um bom lugar para começar.
  • Ajude-nos a melhorar a nossa documentação. Registre um issue se encontrar algo confuso, algum erro gramatical ou que possa ser melhorado.
  • Take a look at GitHub Discussions and give your opinion into a discussion or consider opening a pull request if you see something you want to work on.

Contribuições são muito bem-vindas!

Nosso processo de desenvolvimento#

O Xplorer usa GitHub como sua fonte de verdade. A equipe principal trabalhará diretamente lá. Todas as alterações serão públicas desde o início.

Relatando novos problemas / bugs.#

Quando for abrir uma nova issue, sempre certifique-se de preencher o template de issues. Usamos issues do GitHub para rastrear bugs públicos. Certifique-se de que sua descrição seja clara e tenha instruções suficientes para corrigir o problema.

  • Uma issue, um bug: Relate um único bug por issue.
  • Forneça etapas de reprodução: Liste todas as etapas necessárias para corrigir a issue. A pessoa que está lendo seu relatório de bug deve ser capaz de seguir estas etapas para reproduzir sua issue com o mínimo de esforço.

Solicitação de Recurso#

Usamos as Discussões no GitHub para rastrear ideias de usuários. Suggest a new feature here! Boas solicitações de recursos tendem a ter:

  • Um resumo rápido da ideia.
  • What & why you wanted to add the specific feature.
  • Additional references like images, links of resources about the feature, etc.

Working on Xplorer code#

Pré-requisito#

Instalação#

  1. Depois de clonar o repositório, execute yarn na raiz do repositório e execute yarn na pasta docs (se você quiser trabalhar no Xplorer Docs).

  2. Para iniciar o Xplorer localmente:

    • execute yarn start na raiz do repositório se você não quiser o recurso de recarregamento rápido.
    • run yarn dev in the root of the repository if you want the hot reload feature.

    To start a local development server serving the Docusaurus docs, go into the docs directory and run yarn start

Gitpod#

Gitpod is a Ready-to-Code environment in which you can get started immediately. Gitpod offers all dependencies pre-installed so you can just click and get started.

To get started with Gitpod, click the button below and log in with your GitHub account.

Abrir no Gitpod

Remember to reload the Gitpod website after it loads up since it won't start the servers immediately, but by reloading, you can get it started. If you are developing the app, go to the Remote Explorer on the sidebar and visit port 6080 which opens the noVNC app server. If you are developing the docs, go to the Remote explorer but instead of port 6080, visit port 3000. You can edit normally as you do in VS Code, but if you want to use it locally, clik the hamburger menu button and click Open in VS Code. :::

Semantic commit messages#

See how a minor change to your commit message style can make you a better programmer.

Format: <type>(<scope>): <subject>

<scope> is optional

Exemplo#

feat: allow overriding of webpack config^--^  ^------------^|     ||     +-> Summary in present tense.|+-------> Type: chore, docs, feat, fix, refactor, style, or test.

the various types of commits:

  • feat: new feature for the user
  • fix: bug fix for the user
  • docs: changes to the documentation
  • style: formatting, missing semi-colons, etc.
  • refactor: refactoring production code, eg. renaming a variable
  • test: adding missing tests, refactoring tests.
  • chore: updating grunt tasks etc

Use lower case not the upper case!

Working on Xplorer docs#

Xplorer documentation website is built using Docusaurus 2, and its code is located at docs folder.

Prerequisite#

Instalação#

After cloning the repository, run yarn in the docs folder (you can go into the docs folder by running the cd docs command).

If you want to use Gitpod, click here for the guide on how to use Gitpod.

Local development#

  1. Run the yarn start command in the docs folder.
  2. Edit some markdown texts in the docs folder and the website will be hot reloaded.

Pull requests#

Your first pull request.#

So you have decided to contribute code back to upstream by opening a pull request. You've invested a good chunk of time, and we appreciate it. We will do our best to work with you and get the PR looked at.

Working on your first Pull Request? Você pode aprender como usar nesta série de vídeos:

Como Contribuir com um Projeto de Código Aberto no GitHub

Temos uma lista de problemas para iniciantes para ajudá-lo a começar a usar a base de código do Xplorer e familiarizar com nosso processo de contribuição. Este é um ótimo lugar para começar.

Propondo uma alteração#

If you would like to request a new feature or enhancement but are not yet thinking about opening a pull request, you can also open a discussion and others will code it!

If you intend to fix a bug, please discuss it through Issues before submitting a pull request.

If you intend to add a new feature, please discuss it through GitHub Discussions to avoid multiple people working on the same feature request.

Enviando uma pull request#

certifique-se de que o PR faça apenas uma coisa, caso contrário, divida-o. It is recommended to follow this commit message style.

  1. Fork the repository and create your branch from master.
  2. Make changes and ensure your commit message is understandable.
  3. Open a PR and ensure to describe your pull request clearly.

Working on Xplorer resources#

Locales#

We host our locales on the crowdin. To translate it, please follow these steps:

  • Sign up on Crowdin and Join our project here.
  • Make sure your locale exists there, if it does not exist, leave a comment in this discussion and I'll add the language option :)
  • Get familiar with the Crowdin translation UI, as you will need to use it to translate JSON and Markdown files
  • Translate the content!

Priority Files to translate on Crowdin#

  1. src/Locales files
  2. docs/docs files
  3. docs/i18n/en files
  4. docs/community files

Produção#

Once the files on src/Locales have been translated for more than 80%, we will add it into the Xplorer app, and for the docs, we will add it into production once the translation looks good!

Por favor, comente aqui se você tiver alguma dúvida!

Ícone de arquivo#

Files icons are available on src/Icon. Você pode adicionar um ícone seguindo estas etapas:

Biblioteca de Tipo de Arquivo#

The files type library is available on src/Components/Files/File Type/type.json.

You can add the type of file extension by adding value to the file.