Fix/project structure docs 346 #348
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Created GetRandomWelcomeMessage function in greeting.py with 10 different greeting variations - Updated auth.py to use random greetings instead of static message - Includes original greeting message plus 9 new variations - All changes pass ruff linting checks Closes Code-A2Z#327
- Added detailed project structure section with visual directory tree - Documented all major directories and their purposes - Included explanations for the modular organization - Follows the suggested format from issue Code-A2Z#346 - Places the section after Features and before Contributing guidelines Closes Code-A2Z#346
|
Thank you for submitting your pull request! We'll review it as soon as possible. For further communication, join our discord server https://discord.gg/tSqtvHUJzE. |
Member
|
Closed: Due to not assigned. Don't start work until not assigned. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes: #346
Describe the add-ons or changes you've made 📃
Added comprehensive project structure documentation to README.md with a detailed directory tree and explanations. This addresses issue #346 by making it easier for new contributors to understand the project organization.
Changes:
Working Video 📷
The changes are documentation-only, showing the updated README with project structure information.
Type of change ☑️
Note to reviewers 📄
The project structure documentation provides a clear overview of how the Jarvis project is organized, making it easier for new contributors to navigate the codebase. The directory tree shows the hierarchical structure and the purpose of each major component.