GitHub Organizing

[anateran0501]

No description provided.

[JuanSCampos]

To accomplish this point regarding Git best practices for our GitHub repository, we can follow these suggestions:

1. Organize Branching Strategy

Use a branching model like GitFlow to organize development work. Have branches for:

• Main branch (or master/main) for stable releases.
• Develop branch for integrating features before merging to main.
• Feature branches for each major feature or component (e.g., feature/frame-extraction, feature/caption-generation).
• Ensure each team member works on separate feature branches and creates pull requests (PRs) to merge changes.

2. Meaningful Commit Messages

• Use descriptive commit messages that follow a consistent pattern. For example:
• Start with a verb (e.g., Add, Fix, Update).
• Include the feature and summary (e.g., Add frame extraction script for GIFs).
• Break larger changes into multiple commits with specific details about each modification.

3. Pull Requests (PRs) with Reviews

• Create pull requests to merge features into the main branch. Use code reviews to ensure quality:
• Add descriptions to PRs detailing the changes made, why they were necessary, and how they were tested.
• Include assignments for code review, tagging at least one other team member.
• Link PRs to relevant issues to maintain clarity.

4. Project Board Updates

• Use the GitHub Project Board to track progress:
• Make sure tasks are properly organized under To Do, In Progress, and Done columns.
• Link issues and pull requests to tasks on the board to improve visibility.
• Regularly update the board during meetings to ensure team members know the current state of the project.

5. Documentation

• Ensure the README file includes the following:
• Project Overview: The goal, the importance of enhancing accessibility through GIF descriptions.
• Installation and Setup Instructions: How to clone the repository, set up the environment, and run the project.
• Usage Guide: Examples of how users can interact with the system, along with instructions for running the main scripts.
• Team Contributions: Add a section on team roles or a CONTRIBUTORS.md to acknowledge each member's work.

6. Issues and Labels

• Use GitHub Issues to track bugs, improvements, and new features.
• Apply labels to categorize issues, such as enhancement, bug, documentation, etc., to help the team easily identify the nature of each issue.

[JuanSCampos]

Labels and milestones were linked to each issue/task.