Skip to content

Feature - Creating Readme file #1

@GroophyLifefor

Description

@GroophyLifefor

Tr:
Readme eksikliğinden insanlar projenin ne olduğunu ve nasıl katkı sağlayacaklarını anlayamıyorlar.

Readme'nin içermesi gerekenler:

  • İnsanlar projeyi anlayabilmeli.
  • Katkı sağlayıcılar projeyi nasıl derleyebileceklerini anlayabilmeli.
  • Katkı sağlayıcılar yerel testleri nasıl çalıştırabileceklerini anlayabilmeli.
  • Katkı sağlayıcılar eklenen/değişen/silinen kodu nasıl katkı yapacaklarını anlayabilmeli.

En:
The lack of a readme file means that people don't really understand what the project is about and it's not clear how they can contribute.

What the readme should contain:

  • People have to understand project.
  • Contributer have to understand how to build project.
  • Contributer have to understand how to run local tests.
  • Contributer have to understand how to contribute changed code.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions