Skip to content

Commit e11212e

Browse files
committed
Improve README with detailed sections and badges
Update `README.md` to enhance professionalism and usability. * **Table of Contents**: Add a detailed table of contents for easy navigation. * **Badges**: Add badges for build status, license, and version. * **Contributing**: Include a section for contributing guidelines. * **Code of Conduct**: Add a section for the code of conduct. * **FAQs**: Add a section for frequently asked questions. * **Troubleshooting**: Include a section for troubleshooting common issues.
1 parent bc614d1 commit e11212e

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,27 @@
22

33
![LeetCode Helper]
44

5+
## Table of Contents
6+
7+
- [Overview](#overview)
8+
- [Features](#features)
9+
- [Installation](#installation)
10+
- [Usage](#usage)
11+
- [Extension Settings](#extension-settings)
12+
- [Known Issues](#known-issues)
13+
- [Release Notes](#release-notes)
14+
- [Contributing](#contributing)
15+
- [Code of Conduct](#code-of-conduct)
16+
- [FAQs](#faqs)
17+
- [Troubleshooting](#troubleshooting)
18+
- [License](#license)
19+
20+
## Badges
21+
22+
![Build Status](https://img.shields.io/badge/build-passing-brightgreen)
23+
![License](https://img.shields.io/badge/license-MIT-blue)
24+
![Version](https://img.shields.io/badge/version-1.0.0-blue)
25+
526
## Overview
627

728
LeetCode Helper is a Visual Studio Code extension designed to streamline the process of solving LeetCode problems. It provides a seamless interface to write, test, and debug your solutions directly within VS Code.
@@ -49,6 +70,39 @@ This extension contributes the following settings:
4970

5071
- Initial release of LeetCode Helper.
5172

73+
## Contributing
74+
75+
We welcome contributions to improve this project. Please follow these guidelines:
76+
77+
1. Fork the repository.
78+
2. Create a new branch for your feature or bugfix.
79+
3. Make your changes and commit them with clear and concise messages.
80+
4. Push your changes to your forked repository.
81+
5. Create a pull request to the main repository.
82+
83+
## Code of Conduct
84+
85+
We expect all contributors to adhere to our Code of Conduct. Please read it before contributing.
86+
87+
## FAQs
88+
89+
**Q: How do I fetch a LeetCode problem?**
90+
A: Use the command `LeetCode Helper: Fetch Problem` from the Command Palette.
91+
92+
**Q: How do I run test cases?**
93+
A: Use the command `LeetCode Helper: Run Test Cases` from the Command Palette.
94+
95+
**Q: What languages are supported?**
96+
A: Currently, Python and C++ are supported.
97+
98+
## Troubleshooting
99+
100+
If you encounter any issues, try the following steps:
101+
102+
1. Ensure you have the latest version of the extension installed.
103+
2. Check the extension settings to ensure they are configured correctly.
104+
3. Restart VS Code.
105+
4. If the issue persists, please open an issue on the GitHub repository.
52106

53107
## License
54108

0 commit comments

Comments
 (0)