Skip to content

Commit 067167a

Browse files
authored
Update README.md
1 parent f5720da commit 067167a

File tree

1 file changed

+61
-7
lines changed

1 file changed

+61
-7
lines changed

README.md

Lines changed: 61 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,68 @@
1-
# LeetCode-Solutions
1+
# Contributing to LeetCode-Solutions
22

3-
LeetCode Solutions of JRS296.
3+
Thank you for considering contributing to **LeetCode-Solutions**! This repository is a collection of solutions to LeetCode problems in multiple programming languages. Please read the following guidelines to ensure a smooth contribution process.
44

5+
## 🛠 How to Contribute
56

6-
Tags:
7+
1. **Fork the repository**: Click on the **Fork** button at the top right corner of this page.
8+
2. **Clone your fork**:
9+
```sh
10+
git clone https://github.com/your-username/LeetCode-Solutions.git
11+
```
12+
3. **Create a new branch**:
13+
```sh
14+
git checkout -b feature/your-feature-name
15+
```
16+
4. **Add your solution** following the structure below:
17+
- Each problem should be a separate folder named using the format:
18+
```
19+
#num - Name - Difficulty
20+
```
21+
Example:
22+
```
23+
#1 - 2 Sum - Easy
24+
```
25+
- Inside the folder, include solutions in different languages and a Markdown file explaining the solution. Example:
26+
```
27+
#1 - 2 Sum - Easy
28+
├── 2 Sum - Solution.java
29+
├── 2 Sum - Solution.cpp
30+
├── 2 Sum - Solution.py
31+
├── 2 Sum - Explanation.md
32+
```
33+
5. **Commit your changes**: Use the following format for commit messages:
34+
```sh
35+
git commit -m "Solution #num - Creator/Edited - Date"
36+
```
37+
or for explanations:
38+
```sh
39+
git commit -m "Explanation #num - Creator/Edited - Date"
40+
```
41+
6. **Push your branch**:
42+
```sh
43+
git push origin feature/your-feature-name
44+
```
45+
7. **Create a Pull Request (PR)**: Go to the repository on GitHub and click "New Pull Request".
746

8-
I - Important
47+
## 📌 Contribution Guidelines
948

10-
R - Revise
49+
- **Follow the folder and file structure** as outlined above.
50+
- **Commit Messages**: Ensure that commit messages follow the specified format.
51+
- **Pull Requests**: Keep PRs focused and limited to a single problem solution or explanation.
52+
- **Discussions**: Use GitHub Issues for bug reports, feature requests, or discussions before implementing major changes.
53+
- **Documentation**: Ensure that the `Explanation.md` file is well-written and clearly explains the approach used in the solutions.
1154

12-
G - Good
55+
## 🚀 Issue Tracking
1356

14-
L - Learn
57+
- If you find an issue with an existing solution or have a suggestion, please [open an issue](https://github.com/Dijkstra-Edu/LeetCode-Solutions/issues).
58+
- When reporting issues, include relevant details such as problem number, expected vs. actual behavior, and language-specific concerns.
59+
60+
## 📜 License
61+
62+
By contributing, you agree that your contributions will be licensed under the repository's license.
63+
64+
## 💬 Need Help?
65+
66+
If you have any questions, feel free to open an issue or start a discussion in the repository.
67+
68+
Happy coding! 🎉

0 commit comments

Comments
 (0)