docs(readme): add contributor setup, folder structure, and dev workflow#2
Open
Sumith-Kumar-Saini wants to merge 2 commits intoankurdotio:mainfrom
Open
docs(readme): add contributor setup, folder structure, and dev workflow#2Sumith-Kumar-Saini wants to merge 2 commits intoankurdotio:mainfrom
Sumith-Kumar-Saini wants to merge 2 commits intoankurdotio:mainfrom
Conversation
This helps new contributors get started
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README.md to provide enhanced contributor guidance and a streamlined development setup.
- Adds a tech stack overview, folder structure explanation, and detailed development instructions
- Improves header styling with emojis and refines wording for clarity
Comments suppressed due to low confidence (1)
readme.md:58
- The closing code block delimiter uses four backticks instead of three, which may cause rendering issues. Please adjust it to use three backticks for consistency with the opening fence.
</details>
Owner
|
The Readme is good but the folder structure mentioned in the readme file is not accurate and missing some folders and files |
Owner
|
@Sumith-Kumar-Saini can you please update the folder structure part of readme file and if you can add some additional information for folders and files that will be great. |
Author
|
@Ankur77720 OK Sir, I will try my best |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
📌 Summary
This PR enhances the
README.mdto include:These updates aim to help new contributors get started without needing a separate CONTRIBUTING file.
Closes #1