Ir para o conteúdo principal

Guia de Contribuição

Se você deseja contribuir com a base de código necord ou documentação, sinta-se à vontade para bifurcar o repositório e enviar uma pull request. Usamos ESLint para impor um estilo de código consistente, para que isso seja configurado no editor de escolha reduz a fricção que contribui para este projeto.

Configuração​

Você precisará de Node.js versão 18+, e npm.

Para se preparar para trabalhar na base de código, por favor faça o seguinte:

  1. Faça um fork & clone do repositório. Certifique-se de que você está atualizado com a branch master!
  2. Install the dependencies using yarn install or npm install
  3. Programe seu coração!
  4. Run yarn lint to run ESLint and ensure changes respect our styleguide
  5. Envie um pull request (Certifique-se de que você segue o formato convencional de commit)

Uma visão geral de alto nível das ferramentas usadas:

Contributing to Documentation​

If you want to contribute to the documentation, you can do so by editing the files in the docs repository. The documentation is written in Markdown, so you can use any Markdown editor to make changes. Use yarn dev to start a local server and preview your changes.

Before submitting a pull request, please ensure that:

  • Use Markdown for formatting
  • Use MDX for embedding React components
  • Use GitHub Flavored Markdown for code blocks
  • Use anchor links for internal links (e.g. #contributing-to-documentation)

Contributors​

Contributors