Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
136 lines (94 loc) · 3.82 KB

CONTRIBUTING.md

File metadata and controls

136 lines (94 loc) · 3.82 KB

🤝 Contributing to Pixel Study

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.

We welcome all kinds of contributions — from fixing typos and improving documentation to adding new features or refining the UI.
Let's make this project awesome together 💪

📑 Table of Contents

💡 Contribution Ideas

You can contribute by:

  • 🧠 Improving UI/UX or responsiveness

  • 🌙 Enhancing dark mode

  • 🧾 Adding new features (like subject search or category filters)

  • 🪶 Fixing typos or optimizing code

  • 🧰 Improving documentation (README, setup guide, etc.)

If unsure, check the Issues tab for open ideas or discussions.

🚀 How to Contribute

1️⃣ Fork the Repository

Click the Fork button (top-right corner of the repo) to create your own copy of this repository.

2️⃣ Clone Your Fork

Use this command to clone your forked repository:

git clone https://github.com/<your-username>/Study-Resource-Hub.git

3️⃣ Open the Project

Navigate to your cloned folder:

# Copy code
cd Study-Resource-Hub
# Then open the project in your favorite code editor (like VS Code).

4️⃣ Create a New Branch

Create a feature or fix branch to keep your changes organized:

git checkout -b feature/your-feature-name
# Example: feature/add-dark-mode or fix/resource-delete-bug

🧠 Make Your Changes

Edit the files you want to improve. You can modify:

index.html → App structure

style.css → Design and layout

index.js → Functionality and logic

🧩 Contribution Guidelines

  • Keep your changes clean and readable.

  • Comment your code where necessary.

  • Follow consistent naming conventions and indentation.

  • Make sure your code doesn’t break existing features.

  • Create meaningful commit messages.

Example: Added dark mode toggle feature

Pull Request Process

Commit your changes:

Copy code
git add .
git commit -m "Added new feature: <describe change>"

5️⃣ Push to your fork

# Copy code
git push origin feature/your-feature-name
# Create a Pull Request (PR)
# Go to your forked repo on GitHub and click “New Pull Request”.
# Fill out the Pull Request Template properly.

** Wait for review ** Maintainers will review your PR. If changes are needed, they’ll comment — please respond politely and make updates.

Merge 🎉 Once approved, your PR will be merged and you’ll officially be an open-source contributor!

💬 Community and Behavior

We want this to be a friendly and respectful place for everyone. Please follow our Code of Conduct to ensure a welcoming environment.

🧠 Code of Conduct

Please be respectful and kind in all interactions. We aim to keep this community welcoming and beginner-friendly. Check out the CODE_OF_CONDUCT.md for details.

💡 Need Help?

If you’re stuck or confused about anything:

  • Open a discussion or issue in the repository.

  • Tag maintainers in your comments.

  • Be patient and polite — we’re all learning together. 😊

⭐ Pro Tip

If this is your first open-source contribution, don’t worry — everyone starts somewhere. Even fixing a small typo or improving documentation counts! 🙌

Made with ❤️ by pixel study and open-source contributors.