CIS3590-G1B / GROUP-1B-Java

All Algorithms implemented in Java
MIT License
1 stars 0 forks source link

ISSUE#4.3.1- BRIAN - ISSUE TESTING - README DOCUMENTATION #22

Closed ba-00001 closed 3 weeks ago

ba-00001 commented 1 month ago

What would you like to share?

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:

Next Steps:


Issue #X.X: [Insert Issue Title (e.g., Testing and Validation)]

Week [Insert Week Number] Tasks:

Progress Summary:

Challenges Encountered:

Key Commit:

Next Steps:


Issue #X.X: [Insert Issue Title (e.g., Pull Request Preparation)]

Week [Insert Week Number] Tasks:

Progress Summary:

Challenges Encountered:

Key Commit:

Next Steps:


Commit Guidelines for This Week:

Each commit will adhere to the following format for consistency:

Example Commit Messages for this Week:


Next Steps and Upcoming Tasks:


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:

Additional information

No response

ba-00001 commented 3 weeks ago

Algorithm Development - Adding Hare and Tortoise Algorithm*

ISSUE#: 4.1-BRIAN
Title: Adding Hare and Tortoise Algorithm
Prepared by: Brian Bazurto
Date: 11/01/2024


1. Problem Definition and Clarification


2. Input/Output Specifications


3. Constraints and Requirements


4. Data Structures


5. Algorithm Design Approach


6. Edge Cases and Error Handling


7. Optimization


8. Testing and Debugging


9. Documentation and Maintenance


Comments/Notes

This algorithm is commonly used in technical interviews for cycle detection, and this implementation provides a practical example for understanding the two-pointer technique.


Version History

Date Changes Made Version
11/01/2024 Initial Draft 1.0