Adding_learn.md file #655
Adding_learn.md file #655
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughWalkthroughThe Changes
Assessment against linked issues
Tip New Features and ImprovementsReview SettingsIntroduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments. AST-based InstructionsCodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation. Community-driven AST-based RulesWe are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information. New Static Analysis ToolsWe are continually expanding our support for static analysis tools. We have added support for Tone SettingsUsers can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:
Revamped Settings PageWe have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to Miscellaneous
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
|
Thank you, @aasthakourav20, for creating this pull request and contributing to GitHub-ReadMe! 💗 Our review team will thoroughly review the pull request and will reach out to you soon! 😇 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
Outside diff range and nitpick comments (1)
LEARN.md (1)
12-12: Consider using a stronger word than "give" to enhance the impact of the sentence. Perhaps "provide" or "offer" could be used here.
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- LEARN.md (1 hunks)
Additional Context Used
LanguageTool (3)
LEARN.md (3)
Near line 12: Try using a synonym here to strengthen your writing.
Context: ...he academic demands of the students and give assistance to them in every way possibl...
Rule ID: GIVE_PROVIDE
Near line 16: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...fs related to experiment, viva, quizzes question, the mid and end semester examination a...
Rule ID: AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER
Near line 16: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...zzes question, the mid and end semester examination as well as the assignments. - We are p...
Rule ID: AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER
Markdownlint (40)
LEARN.md (40)
39: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time
5: Expected: 0; Actual: 1
Unordered list indentation
6: Expected: 0; Actual: 1
Unordered list indentation
7: Expected: 0; Actual: 1
Unordered list indentation
8: Expected: 0; Actual: 1
Unordered list indentation
9: Expected: 0; Actual: 1
Unordered list indentation
15: Expected: 0; Actual: 1
Unordered list indentation
16: Expected: 0; Actual: 1
Unordered list indentation
17: Expected: 0; Actual: 1
Unordered list indentation
40: Expected: 0; Actual: 1
Unordered list indentation
41: Expected: 0; Actual: 1
Unordered list indentation
42: Expected: 0; Actual: 1
Unordered list indentation
43: Expected: 0; Actual: 1
Unordered list indentation
1: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
4: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
11: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
14: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
19: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
39: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
45: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
48: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
19: null
Headings must start at the beginning of the line
45: null
Headings must start at the beginning of the line
48: null
Headings must start at the beginning of the line
23: null
Fenced code blocks should be surrounded by blank lines
25: null
Fenced code blocks should be surrounded by blank lines
27: null
Fenced code blocks should be surrounded by blank lines
29: null
Fenced code blocks should be surrounded by blank lines
31: null
Fenced code blocks should be surrounded by blank lines
35: null
Fenced code blocks should be surrounded by blank lines
5: null
Lists should be surrounded by blank lines
15: null
Lists should be surrounded by blank lines
37: null
Lists should be surrounded by blank lines
40: null
Lists should be surrounded by blank lines
2: null
Bare URL used
46: null
Bare URL used
49: null
Bare URL used
23: null
Fenced code blocks should have a language specified
27: null
Fenced code blocks should have a language specified
31: null
Fenced code blocks should have a language specified
| # Amupedia | ||
| Visit our website [Amupedia]https://www.amupedia.com/ | ||
|
|
||
| ## Table of Contents | ||
| - Introduction | ||
| - Features | ||
| - Getting Started | ||
| - Contribuitng Guidelines | ||
| - Code of Conduct | ||
|
|
||
| ## Introduction | ||
| Amupedia is the biggest platform to help fellow students through their college program. This initiative will cater to the academic demands of the students and give assistance to them in every way possible. Everyone out there is running in the race to the top, and we here offer a push to anyone who needs it. Whether you come for the notes, read our blogs, or attend our events, you will emerge from Amupedia with new knowledge, perspective, influences, and connections. | ||
|
|
||
| ## Features | ||
| - Providing you with all the quality stuff related to B.Tech, B.Com, B.E, and various other courses. | ||
| - The pdfs related to experiment, viva, quizzes question, the mid and end semester examination as well as the assignments. | ||
| - We are providing all this content for free. | ||
|
|
||
| ## Getting Started | ||
| 1). Fork the repository (Click the Fork button in the top right of this page, click your Profile Image) | ||
| 2). Clone the forked repository to your local machine. | ||
| 3). Make your branch from test branch. | ||
| ``` | ||
| git clone https://github.com/your-username/Project-Amupedia.git | ||
| ``` | ||
| 4). Change the present working directory | ||
| ``` | ||
| cd Project-Amupedia | ||
| ``` | ||
| 5).Make your changes | ||
| ``` | ||
| git add . | ||
| git commit -m "Your commit Message" | ||
| git push origin branch-name | ||
| ``` | ||
| 6). Make a pull request. | ||
| - Star the repository. | ||
|
|
||
| #### Building Amupedia | ||
| - Install npm from browser(windows), using sudo apt install npm(linux) in the terminal | ||
| - In the root directory: npm install for downloading all the dependencies needed for the project | ||
| - Run npm run build for building the project | ||
| - Run npm run dev This will start the server on localhost:3000 | ||
|
|
||
| ## Contribuitng Guidelines | ||
| For the enthusiasts who want to contribute to CodeHarbourHub, please refer to our [Contributing Guidelines]https://github.com/amupedia2021/amupedia-web/blob/develop/CONTRIBUTING.md | ||
|
|
||
| ## Code of Conduct | ||
| For all the enthusiastic contributers, please refer to the [Code of Conduct]https://github.com/amupedia2021/amupedia-web?tab=coc-ov-file | ||
|
|
||
| Happy Coding!! |
There was a problem hiding this comment.
Please address the following formatting issues to improve the readability and structure of the document:
- Ensure that headings are surrounded by blank lines.
- Correct the indentation of unordered lists.
- Ensure that fenced code blocks are surrounded by blank lines and specify the language for syntax highlighting.
- # Amupedia
+ # Amupedia
+
- ## Table of Contents
+ ## Table of Contents
+
- ## Introduction
+ ## Introduction
+
- ## Features
+ ## Features
+
- ## Getting Started
+ ## Getting Started
+
- ### Building Amupedia
+ ### Building Amupedia
+
- ## Contribuitng Guidelines
+ ## Contribuitng Guidelines
+
- ## Code of Conduct
+ ## Code of Conduct
+
- - Introduction
+ - Introduction
- - Features
+ - Features
- - Getting Started
+ - Getting Started
- - Contribuitng Guidelines
+ - Contribuitng Guidelines
- - Code of Conduct
+ - Code of Conduct
- - Providing you with all the quality stuff related to B.Tech, B.Com, B.E, and various other courses.
+ - Providing you with all the quality stuff related to B.Tech, B.Com, B.E, and various other courses.
- - The PDFs related to experiments, viva, quiz questions, mid and end semester examinations, as well as assignments.
+ - The PDFs related to experiments, viva, quiz questions, mid and end semester examinations, as well as assignments.
- - We are providing all this content for free.
+ - We are providing all this content for free.
- - Install npm from browser(windows), using sudo apt install npm(linux) in the terminal
+ - Install npm from browser(windows), using sudo apt install npm(linux) in the terminal
- - In the root directory: npm install for downloading all the dependencies needed for the project
+ - In the root directory: npm install for downloading all the dependencies needed for the project
- - Run npm run build for building the project
+ - Run npm run build for building the project
- - Run npm run dev This will start the server on localhost:3000
+ - Run npm run dev This will start the server on localhost:3000
- ```
+ ```
- git clone https://github.com/your-username/Project-Amupedia.git
+ git clone https://github.com/your-username/Project-Amupedia.git
- ```
+ ```
- cd Project-Amupedia
+ cd Project-Amupedia
- ```
+ ```
- git add .
+ git add .
- git commit -m "Your commit Message"
+ git commit -m "Your commit Message"
- git push origin branch-name
+ git push origin branch-name
- ```
+ ```
- - Star the repository.
+ - Star the repository.| 6). Make a pull request. | ||
| - Star the repository. | ||
|
|
||
| #### Building Amupedia |
There was a problem hiding this comment.
The heading "Building Amupedia" should be an h3 instead of h4 to maintain proper heading hierarchy.
- #### Building Amupedia
+ ### Building AmupediaCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| #### Building Amupedia | |
| ### Building Amupedia |
| - Run npm run dev This will start the server on localhost:3000 | ||
|
|
||
| ## Contribuitng Guidelines | ||
| For the enthusiasts who want to contribute to CodeHarbourHub, please refer to our [Contributing Guidelines]https://github.com/amupedia2021/amupedia-web/blob/develop/CONTRIBUTING.md |
There was a problem hiding this comment.
Correct the markdown link format for better accessibility and readability.
- For the enthusiasts who want to contribute to CodeHarbourHub, please refer to our [Contributing Guidelines]https://github.com/amupedia2021/amupedia-web/blob/develop/CONTRIBUTING.md
+ For the enthusiasts who want to contribute to CodeHarbourHub, please refer to our [Contributing Guidelines](https://github.com/amupedia2021/amupedia-web/blob/develop/CONTRIBUTING.md)Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| For the enthusiasts who want to contribute to CodeHarbourHub, please refer to our [Contributing Guidelines]https://github.com/amupedia2021/amupedia-web/blob/develop/CONTRIBUTING.md | |
| For the enthusiasts who want to contribute to CodeHarbourHub, please refer to our [Contributing Guidelines](https://github.com/amupedia2021/amupedia-web/blob/develop/CONTRIBUTING.md) |
|
|
||
| ## Features | ||
| - Providing you with all the quality stuff related to B.Tech, B.Com, B.E, and various other courses. | ||
| - The pdfs related to experiment, viva, quizzes question, the mid and end semester examination as well as the assignments. |
There was a problem hiding this comment.
Correct the grammatical number of nouns:
- Change "pdfs" to "PDFs" for proper capitalization.
- Change "quizzes question" to "quiz questions" for correct pluralization.
- - The pdfs related to experiment, viva, quizzes question, the mid and end semester examination as well as the assignments.
+ - The PDFs related to experiments, viva, quiz questions, mid and end semester examinations, as well as assignments.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| - The pdfs related to experiment, viva, quizzes question, the mid and end semester examination as well as the assignments. | |
| - The PDFs related to experiments, viva, quiz questions, mid and end semester examinations, as well as assignments. |
| For the enthusiasts who want to contribute to CodeHarbourHub, please refer to our [Contributing Guidelines]https://github.com/amupedia2021/amupedia-web/blob/develop/CONTRIBUTING.md | ||
|
|
||
| ## Code of Conduct | ||
| For all the enthusiastic contributers, please refer to the [Code of Conduct]https://github.com/amupedia2021/amupedia-web?tab=coc-ov-file |
There was a problem hiding this comment.
Correct the markdown link format for better accessibility and readability.
- For all the enthusiastic contributers, please refer to the [Code of Conduct]https://github.com/amupedia2021/amupedia-web?tab=coc-ov-file
+ For all the enthusiastic contributors, please refer to the [Code of Conduct](https://github.com/amupedia2021/amupedia-web?tab=coc-ov-file)Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| For all the enthusiastic contributers, please refer to the [Code of Conduct]https://github.com/amupedia2021/amupedia-web?tab=coc-ov-file | |
| For all the enthusiastic contributors, please refer to the [Code of Conduct](https://github.com/amupedia2021/amupedia-web?tab=coc-ov-file) |
|
Hey @anmode , please review it and suggest me whether I really need to makes the changes AI suggested . |
Related Issue
Fixes: #651
Checklist:
Closes: 📚 [Documentation] - Add Learn.md file #651