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.

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

Create Readme file #32

Merged
merged 1 commit into from
Nov 8, 2023
Merged

Create Readme file #32

merged 1 commit into from
Nov 8, 2023

Conversation

NitBravoA92
Copy link
Collaborator

🚩Create Readme file

Hi @Dachrono

I'm sending this pull request for you to review my code. Thanks in advance for your feedback!

Milestones 🎯:

📌 Update the README file to add all the core Front-End project documentation. This documentation contains the following sections:

1. About: Project Overview

2. Built With: Description of the technologies used for the development of the project and the Key Features

3. Back-End Project: Link to the Back-End repository of the project

4. Getting Started: Contains a guide with the necessary steps to clone, install and run the project

5. Authors: Names and contact information of the project development team

6. Future Features: This section shows the list of features that are planned to be implemented in the future

7. Contributing: Show information about how you can contribute to this project

8. Show your support: This section shows information about how to support this project

9. Acknowledgments: This section shows relevant information about the original UI design of the project, the author's rights and shows words of gratitude from the project developers.

10. License: Shows all the necessary information about the project License.

⭐To the code reviewer 👨‍💻

Please, I kindly ask you to review the entire code and verify that all requirements have been met correctly.
if there is any issue 🦯 in this PR, please do list 📃 them in a descriptive 💡 manner and give your best suggestions 🎁 if needed.

@NitBravoA92 NitBravoA92 added the documentation Improvements or additions to documentation label Nov 7, 2023
@NitBravoA92 NitBravoA92 self-assigned this Nov 7, 2023
@NitBravoA92 NitBravoA92 linked an issue Nov 7, 2023 that may be closed by this pull request
Copy link
Collaborator

@Dachrono Dachrono left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello Carmen! 👋

Congratulations! 🎉

Great Job I can see your effort 😄 👏 You've done it. Your feature is complete! There is nothing else to say 👍🏻 ✅ 🥳 🎉

STATUS: APPROVED ✅ 🍾

To Highlight 💯

  • Descriptive pr👍
  • Good and clean implementation👍
  • No error linters 👍

Congratulations! 🎉

congrats

Optional suggestions

Every comment with the [OPTIONAL] prefix won't stop the approval of this PR. However, I strongly recommend you to take them into account as they can make your code better. Some of them were missed by the previous reviewer and addressing them will really improve your application.

Cheers and Happy coding!

As described in the Code reviews limits policy you have a limited number of reviews per project (check the exact number in your Dashboard). If you think that the code review was not fair, you can request a second opinion using this form.

@NitBravoA92 NitBravoA92 merged commit a130997 into dev Nov 8, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[1.5pt] - Add Readme file
2 participants