diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 69d894d..2f27e98 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,24 @@ # 🤝 Contributing to Pixel Study + +## Table of Contents +- [Contribution Ideas](#💡-contribution-ideas) +- [How to Contribute](#🚀-how-to-contribute) + - [Fork the Repository](#1️⃣-fork-the-repository) + - [Clone Your Fork](#2️⃣-clone-your-fork) + - [Open the Project](#3️⃣-open-the-project) + - [Create a New Branch](#4️⃣-create-a-new-branch) + - [Make Your Changes](#🧠-make-your-changes) + - [Contribution Guidelines](#🧩-contribution-guidelines) + - [Pull Request Process](#pull-request-process) + - [Push to your fork](#5️⃣-push-to-your-fork) +- [Community and Behavior](#💬-community-and-behavior) +- [Code of Conduct](#🧠-code-of-conduct) +- [Need Help?](#💡-need-help) +- [Pro Tip](#⭐-pro-tip) + +--- + Hey there! 👋 Thanks for showing interest in contributing to **Pixel Study** — a simple, open-source web app built with HTML, CSS, and JavaScript to help students organize their study materials. diff --git a/README.md b/README.md index 015ae00..fbb9806 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,26 @@ Built using **HTML, CSS, and JavaScript**, this app lets you **add, store, and m --- +## 📑 Table of Contents +- [🌍 Live Demo](#🌍-live-demo) +- [🧩 Features](#🧩-features) +- [🛠️ Tech Stack](#🛠️-tech-stack) +- [🏆 Hacktoberfest 2025](#🏆-hacktoberfest-2025) + - [🧃 Ways to Contribute](#🧃-ways-to-contribute) +- [🚀 Getting Started](#🚀-getting-started) + - [1️⃣ Fork this repo](#1️⃣-fork-this-repo) + - [2️⃣ Clone your fork](#2️⃣-clone-your-fork) + - [3️⃣ Open the project](#3️⃣-open-the-project) + - [4️⃣ Make your changes](#4️⃣-make-your-changes) + - [5️⃣ Commit & push](#5️⃣-commit--push) + - [6️⃣ Create a Pull Request](#6️⃣-create-a-pull-request) +- [💡 Future Ideas](#💡-future-ideas) +- [📄 License](#📄-license) +- [❤️ Acknowledgements](#❤️-acknowledgements) +- [🧑‍💻 Contributors](#🧑‍💻-contributors) + +--- + ## 🌍 Live Demo 👉 *https://pixel-study.vercel.app/*