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

Add tasks description and information about the project #35

Open
M1-Elmasry opened this issue Aug 5, 2024 · 2 comments
Open

Add tasks description and information about the project #35

M1-Elmasry opened this issue Aug 5, 2024 · 2 comments
Assignees

Comments

@M1-Elmasry
Copy link
Collaborator

Suggestion

I suggest adding detailed descriptions of the project's tasks provided by ALX, either in a separate Markdown file or within the existing README.md. I see this addition will enhance the clarity of the tasks completed within this repository, helps viewers in understanding the purpose and scope of each task and recognizing the contributions of team members more clearly.

Proposed Structure

Table of Contents

Task 1: Name (Contributor Name)

Detailed description of Task 1 provided by ALX.

Task 2: Name (Contributor Name)

Detailed description of Task 2 provided by ALX.

Task 3: Name (Contributor Name)

Detailed description of Task 3 provided by ALX.

@Davenchy
Copy link
Owner

Davenchy commented Aug 5, 2024

I completely agree with your suggestion. Additionally, we could reference the issues and To-Do list for each task or feature. Let's focus on completing the mandatory tasks first to save time. After that, we can update the README.md file, as it currently contains incorrect details about our project and file structure. Depending on the size of the updated README, we can decide whether to include the task descriptions in the same file or in a new Markdown file.

  • Complete mandatory tasks
  • Update README file
  • Add tasks detailed descriptions

@Davenchy Davenchy pinned this issue Aug 5, 2024
@Davenchy
Copy link
Owner

We have to update the README file too.

  • Add a link to the task details file.
  • Update the README file to fill the template with our project details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants