Skip to content

Conversation

PrathameshBhagat
Copy link

@PrathameshBhagat PrathameshBhagat commented Oct 4, 2025

While navigating the SDK I felt it would have been better if it already had folder structure mentioned for ease of access.

So I added this folder structure to README.md

This is a very minor change.

Please let me know if I'm supposed to remove the explanations to the directories as in many cases they do not actually explain what the files in those directories do.

P.S.: I'm unaware of why the last line got removed and added for some reason, please let me know if it needs a fix.

P.S. :- I'll start "actually" contributing to the code in the next/future PR's.

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Greptile Overview

Summary

This PR adds a comprehensive directory structure section to the README.md file, documenting the key components of the `src` folder with explanations for each subdirectory. The change is purely documentation-focused and aims to improve developer experience by making the codebase more navigable.

The addition includes a well-formatted tree structure showing the main Java package organization (src/main/java/com/infisical/sdk) with brief descriptions of what each directory contains:

  • api for HTTP method implementations
  • auth for authentication providers like AWS
  • config for storing instance URLs
  • models for data classes with auto-generated getters/setters
  • resources for user-facing methods and auth implementations
  • util for helper functions
  • InfisicalSdk.java as the main wrapper class

The documentation also covers the test directory structure and resources folder. This change follows common open-source practices of providing clear project structure documentation to help new contributors and users understand the codebase organization without manual exploration.

Important Files Changed

Changed Files
Filename Score Overview
README.md 4/5 Added comprehensive directory structure documentation with explanations for each subdirectory in the src folder

Confidence score: 4/5

  • This PR is safe to merge with minimal risk as it only adds documentation without changing any functional code
  • Score reflects the low-risk nature of documentation-only changes that improve developer experience
  • No files require special attention as this is purely a documentation enhancement

Sequence Diagram

sequenceDiagram
    participant User
    participant Repository as "GitHub Repository"
    participant README as "README.md"
    
    User->>Repository: "Navigate SDK structure"
    Repository->>User: "Show current file organization"
    User->>README: "Add directory structure section"
    README->>README: "Insert src/ folder breakdown with explanations"
    User->>Repository: "Submit pull request with enhanced README"
    Repository->>User: "Display improved navigation aid"
Loading

1 file reviewed, 3 comments

Edit Code Review Agent Settings | Greptile

PrathameshBhagat and others added 3 commits October 5, 2025 00:38
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
@PrathameshBhagat
Copy link
Author

Every typo/fixes suggested by Greptile have been resolved/implemented.

@PrathameshBhagat PrathameshBhagat changed the title Adding src folder structure to the README.md Adding "src" folder structure to the README.md Oct 4, 2025
@PrathameshBhagat
Copy link
Author

PrathameshBhagat commented Oct 5, 2025

@fangpenlin @DanielHougaard Can one of you please review this ? P.S. : it shouldn't take long .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant