New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Feature - Creating Readme file #1

Closed

GroophyLifefor opened this issue Feb 9, 2024 · 0 comments · Fixed by #2 · May be fixed by #3

Assignees

Labels

documentation good first issue

Member

GroophyLifefor commented Feb 9, 2024 •

edited

Loading

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.

This was linked to pull requests Feb 12, 2024

Add README file in English #2

Merged

Add README file in Turkish #3

Open

darkbringer1 added the documentation label

darkbringer1 self-assigned this

darkbringer1 added the good first issue label

GroophyLifefor closed this as completed

# for free to join this conversation on GitHub. Already have an account? # to comment