Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

🚀 Feature: Readme.md #184

Open
2 tasks done
Lucas-Bento-D opened this issue Dec 9, 2024 · 1 comment
Open
2 tasks done

🚀 Feature: Readme.md #184

Lucas-Bento-D opened this issue Dec 9, 2024 · 1 comment
Labels
core team work discussion documentation Improvements or additions to documentation repository

Comments

@Lucas-Bento-D
Copy link
Collaborator

🔖 Feature description

We need a Readme learning to execute the project and explain the project tools.

🎤 Why is this feature needed ?

This feature is important for new devs who will contribute for the project, learning about the project and the stacks.

✌️ How do you aim to achieve this?

Development a readme learning how to execute the project

🔄️ Additional Information

No response

👀 Have you spent some time to check if this feature request has been raised before?

  • I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

Are you willing to submit PR?

None
@Lucas-Bento-D Lucas-Bento-D added documentation Improvements or additions to documentation repository core team work discussion labels Dec 9, 2024
@yurimutti
Copy link
Contributor

Cool @Lucas-Bento-D!

It's a good idea to create a readme for all apps and a section on CONTRIBUTING.md for global information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
core team work discussion documentation Improvements or additions to documentation repository
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Lucas-Bento-D @yurimutti