Vasto-Lorde999
commented
1 month ago Weekly Build Documentation - Issue [5635]
Repository: https://github.com/CIS3590-G1B/GROUP-1B-Java
Week 1 - Documentation for Issue 5635
Objective:
Document the progress for the following issues:
- Issue #7 : Feature Development - Fisher-Yates Shuffle Algorithm
- Issue #7 : Testing and Validation of Fisher-Yates Shuffle
- Issue #7 : Pull Request Preparation
Issue #7.2 : Feature Development - Fisher-Yates Shuffle Algorithm
Week 1 Tasks:
- [x] Define the core components of the feature or functionality.
- [x] Implement the feature in the relevant language or framework.
- [x] Ensure that input/output specifications are correctly handled.
Progress Summary:
- Feature Development:
- The Fisher-Yates algorithm was implemented in Java to shuffle arrays in O(n) time complexity.
- Code was structured to ensure clarity and maintainability by using a modular approach for random number generation and swapping logic.
Challenges Encountered:
- Handling special cases like empty arrays and single-element arrays required extra consideration to avoid unnecessary operations.
Key Commit:
feat: implemented Fisher-Yates shuffle algorithm in Java
Next Steps:
- Refine edge case handling and ensure optimal performance for larger datasets.
Issue #7.3 : Testing and Validation of Fisher-Yates Shuffle
Week 2 Tasks:
- [x] Develop comprehensive test cases (typical, boundary, and edge cases).
- [x] Use appropriate testing tools (e.g., JUnit, PyTest, etc.).
- [x] Debug the implementation using test-driven development.
Progress Summary:
- Test Case Development:
- Unit tests for common cases were added, such as shuffling arrays with distinct elements, repeated elements, and varying array sizes
- Boundary and edge cases (e.g., large datasets, empty arrays, arrays with duplicates) were handled and tested to ensure correct behavior.
Challenges Encountered:
- Identifying and addressing the edge cases, such as the behavior with repeated elements and ensuring randomness, required extra verification.
Key Commit:
test: added test cases for Fisher-Yates shuffle including edge cases
Next Steps:
- Perform stress testing to ensure the algorithm scales well with large datasets.
- Review randomness quality for non-uniform data.
Issue #7.4 : Pull Request Preparation
Week 3 Tasks:
- [x] Prepare the code for submission in a pull request.
- [x] Ensure the repository follows coding guidelines and best practices.
- [x] Create documentation for reviewers and link related issues.
Progress Summary:
- Pull Request:
- The pull request has been prepared, and the code has been thoroughly commented for clarity.
- Documentation explaining the algorithm, edge cases, and test results has been included for the reviewers.
- Linked all relevant issues, including feature development and testing validation.
Challenges Encountered:
- Ensuring that all edge case tests passed consistently across multiple runs to guarantee randomness.
Key Commit:
chore: prepared pull request for Fisher-Yates shuffle algorithm and linked issues
Next Steps:
- Finalize the pull request and ensure that all tests, including stress and performance tests, pass in various environments.
Commit Guidelines for This Week:
Each commit will adhere to the following format for consistency:
- Commit Message Format:
feat: implemented Fisher-Yates shuffle algorithmfix: handled edge cases for Fisher-Yates shuffletest: added test cases for Fisher-Yates shufflerefactor: cleaned up Fisher-Yates shuffle implementation
Example Commit Messages for this Week:
feat: implemented Fisher-Yates shuffle algorithm in Javafix: handled edge cases for empty and single-element arraystest: added boundary tests for Fisher-Yates shuffle
Next Steps and Upcoming Tasks:
- Continue refining the algorithm based on peer feedback.
- Finalize testing and documentation for the final pull request.
- Conduct performance testing on large datasets and optimize if needed.
Version Control Summary:
This section summarizes all commits made during the week to ensure proper tracking of changes.
| Date | Changes Made | Commit ID |
|---|---|---|
| [Insert Date] | Implemented basic feature functionality | [Commit ID] |
| [Insert Date] | Added test cases for typical and edge cases | [Commit ID] |
| [Insert Date] | Refactored code and prepared pull request | [Commit ID] |
Documentation Guidelines and References:
For more information on how to structure the repository, make effective commit messages, and ensure security, refer to:
Weekly Build Documentation Template - Issues [Insert Issue Numbers]
Repository: [Insert Repository Name with Link]
Week [Insert Week Number] - Documentation for Issues [Insert Issue Numbers]
Objective:
Document the progress for the following issues:
Issue #X.X: [Insert Issue Title (e.g., Feature Development)]
Week [Insert Week Number] Tasks:
Progress Summary:
Challenges Encountered:
Key Commit:
feat: implemented core functionality for [Insert Feature Name]Next Steps:
Issue #X.X: [Insert Issue Title (e.g., Testing and Validation)]
Week [Insert Week Number] Tasks:
Progress Summary:
Challenges Encountered:
Key Commit:
test: added basic and edge case tests for [Insert Feature/Functionality Name]Next Steps:
Issue #X.X: [Insert Issue Title (e.g., Pull Request Preparation)]
Week [Insert Week Number] Tasks:
Progress Summary:
Challenges Encountered:
Key Commit:
chore: prepared pull request and linked relevant issuesNext Steps:
Commit Guidelines for This Week:
Each commit will adhere to the following format for consistency:
feat: [description of feature]fix: [description of bug fix]test: [description of test]refactor: [description of refactoring task]Example Commit Messages for this Week:
feat: implemented core functionality for [Insert Feature]fix: handled edge cases for [Insert Feature]test: added test cases for [Insert Feature]Next Steps and Upcoming Tasks:
Version Control Summary:
This section summarizes all commits made during the week to ensure proper tracking of changes.
Documentation Guidelines and References:
For more information on how to structure the repository, make effective commit messages, and ensure security, refer to: