Commits

Commit Tracking for Contribution

This project will be hosted on GitHub, and contribution tracking will be a key component of the grading process. Each student in the group of six is expected to actively contribute to the project. Contributions will be verified by reviewing the GitHub commit history. Make sure each person is committing to the repository.

To ensure fairness and accountability, we will be checking the commit history for:

• Each student’s name is associated with their commits.

• Descriptions of what the student did in each commit.

• Clear indications of the part of the project the student worked on.

• An equal frequency of commits between people.

Consequences for Lack of Contribution

If it is determined that a student is not properly contributing to the project, they will be subject to individual grade penalties, even if the overall group project receives a high grade. It is therefore in your best interest to ensure active and visible participation.

Commit Guidelines

To make your contributions clear and maintain a well-documented Git history, follow these guidelines when making commits:

Commit Format

Each commit message should follow this format:

Example

• John Doe - Intent/Slot Classifier - Added initial model for intent classification

Details to Include

1. Your Name: Use your full name or GitHub username so it’s easy to identify your contributions.

2. What You Did: Be specific. Explain what was added, updated, or fixed in a concise manner.

3. Part of the Project: Clearly indicate which component or area of the project the commit relates to, such as:

   • Intent/Slot Classifier

   • Rules

   • Visuals

   • Patterns

   • Report

Good Practices for Commits

• Frequent Commits: Commit your changes regularly. Avoid committing a large chunk of work at once.

• Descriptive Messages: Write clear and descriptive commit messages. Avoid vague descriptions like "Fixed stuff" or "Updated files."

• Small, Focused Changes: Each commit should ideally address a single task or issue.

• Avoid Overwriting Others’ Work: Coordinate with your team to prevent conflicts and overwrites.

Grading Criteria

Your contribution to the project will be evaluated based on:

• Commit History: Evidence of consistent contributions by all team members.

• Quality of Commits: Clear, meaningful, and properly formatted commit messages.

• Collaboration: Balanced distribution of work across team members as evidenced by commits.

Final Notes

• Make sure everyone in the group understands and follows these guidelines.

• Regularly review your GitHub repository’s commit history to ensure compliance.

• If you encounter any issues with Git or coordinating commits, communicate with your group members or reach out for help early.

• Remember: Failure to contribute adequately to the project will result in individual grade penalties, regardless of the group’s overall performance.

By following these guidelines, you will not only ensure fair grading but also gain valuable experience in collaborative software development using Git.