Skip to content

Commit 829c0f9

Browse files
Update README with detailed contribution guidelines
Removed GitHub Pages hosting instructions and added comprehensive steps and guidelines for contributing to the repository. Also included a section encouraging users to star the repo if they find it helpful.
1 parent c6a6ba7 commit 829c0f9

File tree

1 file changed

+34
-16
lines changed

1 file changed

+34
-16
lines changed

README.md

Lines changed: 34 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -26,30 +26,48 @@ Welcome to your comprehensive JavaScript interview notes! This repository contai
2626

2727
---
2828

29-
## 🌐 Hosting on GitHub Pages
30-
This repository is ready to be hosted as a GitHub Pages site for easy access and sharing.
31-
32-
### Steps to Host:
33-
1. **Rename your main markdown file to `index.md` or create an `index.md` in the root.**
34-
2. **Enable GitHub Pages** in your repository settings:
35-
- Go to Settings > Pages
36-
- Select the branch (usually `main` or `master`) and root (`/`) or `/docs` folder
37-
- Save
38-
3. **Access your site** at `https://<your-username>.github.io/<your-repo-name>/`
39-
40-
### Example `index.md` (already provided below):
41-
42-
---
43-
4429
## 📖 Index
4530
- [Functions](functions/functions.md)
4631
- [Closures](Closures/README.md)
4732
- [Event Loop](JS%20Interview%20Question/eventloop.md)
4833

4934
---
5035

36+
37+
5138
## ⭐ Contributing
52-
Feel free to fork, improve, and share these notes!
39+
Contributions are welcome! If you'd like to improve these notes or add new topics, please follow these steps:
40+
41+
### How to Contribute
42+
1. **Fork this repository** to your own GitHub account.
43+
2. **Clone your fork** to your local machine:
44+
```bash
45+
git clone https://github.com/your-username/your-repo-name.git
46+
```
47+
3. **Create a new branch** for your feature or fix:
48+
```bash
49+
git checkout -b my-feature-branch
50+
```
51+
4. **Make your changes** (add notes, fix typos, improve explanations, etc.).
52+
5. **Commit and push** your changes:
53+
```bash
54+
git add .
55+
git commit -m "Describe your changes"
56+
git push origin my-feature-branch
57+
```
58+
6. **Open a Pull Request** on GitHub from your branch to the `main` branch of this repo.
59+
7. **Wait for review and feedback.**
60+
61+
### Contribution Guidelines
62+
- Please keep explanations clear and concise.
63+
- Use code blocks for code examples.
64+
- Add references or links if you use external sources.
65+
- Be respectful and constructive in your feedback and reviews.
66+
67+
Thank you for helping make these notes better for everyone!
68+
69+
## 🌟 Like these notes?
70+
If you found these notes helpful, please consider giving this repo a ⭐ star on GitHub!
5371

5472
---
5573

0 commit comments

Comments
 (0)