Melhorias no README e fluxo de contribuição
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- markdown, next.js, node.js, typescript
- Domain
- developer-experience, documentation
Research direction
Start with README.md and the project's package manifest to verify the Node.js requirement and installed Next.js version. Update the README and add a CONTRIBUTING.md guide covering the fork, branch, and pull request flow. Done means the README reflects the project versions and new contributors can follow the contribution steps.
Written by the indexing model from the issue text.
Description
Objetivo
Esta issue tem como objetivo realizar melhorias no arquivo README.md e no fluxo de contribuição do projeto. As alterações propostas são:
Atualizar fluxo de contribuição:
- Adicionar um guia completo de contribuição, começando pelo fork do repositório, criação de branchs, até o envio do Pull Request.
- Garantir que o fluxo esteja claro e acessível para novos contribuidores.
PS: Avaliar a criação de um arquivo CONTRIBUTING.md para detalhar o fluxo de contribuição, sobretudo para dev's iniciantes
Atualizar pré-requisito do Node.js:
O Node.js 18 é uma versão instável e não recomendada para produção. Além disso, o projeto utiliza a versão 16 do Next.js, que requer Node.js 20 ou superior.
- Atualizar o pré-requisito no README para refletir essa mudança.
Atualizar versão do Next.js no README:
- A versão do Next.js mencionada no README está desatualizada (15.3.3). Atualizar para a versão correta utilizada no projeto, que é 16.2.7.
- Dominant language
- TypeScript
- Stars
- 3
- Forks
- 0
- Avg merge
- 2m
- Merged PRs (30d)
- 6
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from recifefrontendcommunity/rfec
-
Adicionar meta dadosOpenenhancement help wanted
Difficulty 3/5 Half a day Newbie friendliness 35/100
-
enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 28/100
-
enhancement
Difficulty 3/5 Half a day Newbie friendliness 22/100
-
Section dos crachasOpenenhancement
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Adicionar styles para desktopMay be free again @zecacorreia claimed this 491 days ago, and no pull request is open. Openenhancement
recifefrontendcommunity/rfec#5 · 1 assignee ·
All issues in recifefrontendcommunity/rfec
Similar issues
-
content triage
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
tensorflow/tfjs#8754 ·
-
tool-submission
Difficulty 1/5 Under an hour Newbie friendliness 83/100
BraveOPotato/NoSignups#2348 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
code-yeongyu/oh-my-openagent#12784 ·
Maintainers usually reply within 1 day
-
external-issue to-triage
Difficulty 2/5 1-3 hours Newbie friendliness 71/100
Maintainers usually reply within 1 day