Skip to content

Commit ee2cbec

Browse files
SomeshdiwanSomeshdiwan
committed
Final Demo Preview of the Guide.
Signed-off-by: Someshdiwan <[email protected]>
1 parent ef84744 commit ee2cbec

File tree

3 files changed

+147
-9
lines changed

3 files changed

+147
-9
lines changed

‎CONTRIBUTING.md‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎site/CONTRIBUTING.md‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Contribution Guidelines
2+
3+
If you fork or modify this repository, please give credit to the original author: **Somesh Diwan**.
4+
5+
For any significant modifications, a reference back to the original repository is appreciated.
6+
7+
---
8+
9+
## 🚀 How to Contribute
10+
11+
### 1. Fork the Repository
12+
Visit the GitHub repo and click the **"Fork"** button.
13+
14+
### 2. Clone Locally
15+
```bash
16+
git clone https://github.com/Someshdiwan/JavaEvolution-Learning-Growing-Mastering.git
17+
```
18+
19+
### 3. Make Changes
20+
- **Java Code Examples:** Add new examples to directories like `Section*` (e.g., `Section10Methods`, `JAVA8`).
21+
- **Website Enhancements:** Update files inside the `site/` directory (e.g., `index.md`, `style.css`, `_layouts/default.html`).
22+
- Ensure your contributions align with the goal of offering a structured Java learning experience.
23+
24+
### 4. Submit a Pull Request
25+
- Push your changes to your forked repository.
26+
- Open a pull request (PR) to the original repository.
27+
- Include a clear description of the changes you’ve made.
28+
29+
---
30+
31+
## 🖥️ Setup Guide
32+
33+
To run the project locally and test your contributions:
34+
35+
### 1. Clone the Repository
36+
```bash
37+
git clone https://github.com/Someshdiwan/JavaEvolution-Learning-Growing-Mastering.git
38+
```
39+
40+
### 2. Install Jekyll
41+
Follow the [Jekyll Installation Guide](https://jekyllrb.com/docs/installation/) to set it up on your system.
42+
43+
### 3. Navigate to the `site/` Directory
44+
```bash
45+
cd JavaEvolution-Learning-Growing-Mastering/site
46+
```
47+
48+
### 4. Run the Server
49+
```bash
50+
jekyll serve
51+
```
52+
53+
### 5. View the Site
54+
Open your browser and go to:
55+
```
56+
http://localhost:4000
57+
```
58+
59+
---
60+
61+
## 🛠️ Contribution Best Practices
62+
63+
- **Code Quality:** Ensure your Java files compile correctly and are well-commented for educational clarity.
64+
- **Documentation:** Update `Explaination.md` or related `.md` files with explanations of your additions.
65+
- **Testing:** Always test your changes locally using the Jekyll server before submitting.
66+
- **Credit:** Cite external sources properly if you’ve used any.
67+
- **Consistency:** Match the existing structure and naming conventions (`.java`, `.txt`, `.iml`).
68+
69+
---
70+
71+
## ✅ Review Process
72+
73+
- Pull requests are reviewed by the maintainers.
74+
- You may receive feedback to help align your contribution with the project's educational objectives.
75+
- Once approved, your changes will be merged into the main branch.
76+
77+
---
78+
79+
Thank you for contributing to **JavaEvolution**!
80+
Your efforts help create a better resource for Java learners everywhere. 🌱

‎site/index.md‎

Lines changed: 67 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,74 @@
11
---
22
layout: default
3-
title: Home
3+
title: JavaEvolution - Learning, Growing, Mastering
44
---
55

66
# JavaEvolution: Learning, Growing, Mastering
77

8-
Welcome to JavaEvolution, your one-stop guide for mastering Java from basics to advanced concepts.
9-
This repository is structured for learners at every level, featuring categorized content, guides, examples, and best practices.
8+
Welcome to **JavaEvolution**, your all-in-one roadmap to master Java from scratch to advanced levels.
109

11-
> ✍️ _More sections will be added soon as development progresses...
10+
Whether you’re a beginner exploring Java or an experienced developer brushing up concepts, this project helps you grow in a structured and evolutionary way.
11+
12+
---
13+
14+
## 📚 What You’ll Find Here
15+
16+
- 🧠 **Java Basics to Advanced Concepts**
17+
- ⚙️ Hands-on **code examples and best practices**
18+
- 🗂 Categorized topics for **easy navigation**
19+
- 🧱 Built using **GitHub Pages + Jekyll** with PWA support
20+
-
21+
---
22+
23+
## 🔗 Explore the Repository
24+
25+
- 📘 [Index.md](./index.md) – Full documentation and deep dives.
26+
- 📄 [content.md](./content.md) – All pages and contents for the learning roadmap.
27+
- 📁 `site/` – This folder contains everything needed to build the JavaEvolution site with Jekyll.
28+
- 📂 `_includes/` – Reusable components like navigation bar (e.g., `nav.html`).
29+
- 📂 `_layouts/` – HTML templates used for page structure and styling.
30+
- 📂 `assets/` – Static assets like CSS, JS, icons, and PWA files.
31+
32+
- 📁 `Section01Basics/` to `SectionXX.../` – These folders contain categorized Java code examples, each representing a learning section (e.g., methods, OOP, streams).
33+
- 📁 `JAVA8/` – Dedicated section for Java 8 features including streams, lambda expressions, and new APIs.
34+
- 📁 `src/` – Java source files organized by topics; includes runnable code with examples and explanations.
35+
- 📄 `README.md` – Main landing page with project overview and how to get started.
36+
- 📄 `CONTRIBUTING.md` – Guidelines for contributors on how to fork, clone, and contribute.
37+
- 📄 `LICENSE` – Open-source license details for legal use and distribution.
38+
39+
---
40+
41+
## 💡 Contributions Welcome
42+
43+
Want to improve this project or add features? Check out this [CONTRIBUTING.md](./CONTRIBUTING.md)
44+
45+
> This site is open-source and built with ❤️ by developers for developers.
46+
47+
## 🚧 Make The JAVA Great Again – Tasks To Do
48+
49+
> Help us improve JavaEvolution! Contributors are encouraged to pick a task and submit a PR. Let's build a better Java learning experience together.
50+
51+
### 🔧 Feature Tasks for Contributors
52+
53+
- [ ] **Scroll Progress Bar**
54+
Add a visual indicator showing how much content the user has scrolled through on a page. This feature helps users track their progress while navigating long pages.
55+
56+
- [ ] **Search Bar for Topic Navigation**
57+
Implement an in-page or site-wide search bar to allow users to quickly find topics, lessons, or files in the repository.
58+
59+
- [ ] **Styled Visited/Unvisited Links**
60+
Enhance the site's user interface by making visited and unvisited links visually distinct, helping users easily navigate previously explored topics.
61+
62+
- [ ] **Dark Mode Polish & UX Enhancements**
63+
Improve dark mode aesthetics by refining color contrasts, readability, and overall theme consistency across the website.
64+
65+
- [ ] **Improve PWA Caching & Offline Support**
66+
Work on optimizing the Progressive Web App (PWA) functionality by enhancing service worker caching. This would allow users to access content offline more effectively.
67+
68+
- [ ] **Contributor Guide**
69+
Add a comprehensive `CONTRIBUTING.md` file with clear setup instructions, task guidelines, and steps for issue reporting. This will make it easier for new contributors to get started.
70+
71+
- [ ] **UI Enhancements & Animations**
72+
Enhance user interface elements with polished transitions, hover effects, and subtle animations to create a more engaging and modern browsing experience.
73+
74+
---

0 commit comments

Comments
 (0)