Skip to content

Latest commit

 

History

History
152 lines (94 loc) · 4.29 KB

contributing.md

File metadata and controls

152 lines (94 loc) · 4.29 KB
Raw

Contributing to the Library Project 📚✨

Introduction and Purpose 🌟

Hey there! Welcome to the Contributing Guide for the Library Project! I'm Ajay Negi, and I'm absolutely thrilled to have you join us in this open-source adventure. 🚀

About the Library Project 📖

Imagine a magical place where books come alive! 🌟 That's exactly what our Library Project is—a free-to-use haven filled with an incredible collection of books from the Open Library API. Our mission? To create a super-friendly space where everyone, including you, can explore diverse literary wonders, feed your curious minds, and fall in love with the beauty of words. Oh, and did I mention we're all about spreading good vibes and promoting spiritual well-being through daily Geeta shlok? 🌈

Purpose of Contribution 🌍

Your contributions are the heartbeat of our project! 🎉 We need your magic touch to expand the Library, create an awesome user experience, and champion open collaboration. By contributing, you become a superhero in the mission to make knowledge freely accessible to all. 🦸‍♂️✨

Ready to make a difference? Let's get started! 💪🚀

How to Contribute 👀

Contributions are always welcome! Here are ways to get involved:

  • 🐞 Report a Bug: If you find a bug, create an issue with detailed information or submit a pull request if you can fix it.

  • 🎉 New Features: Propose new features by creating an issue to discuss ideas or submit a pull request with the new feature implementation.

  • 💻 Improve User Interface: Enhance the user interface with design improvements. Propose changes to layout, color scheme, or fonts, ensuring a clean and minimal approach.

  • 📄 Improve Documentation: Help improve project documentation by submitting pull requests for the README, code comments, or user guides.

Getting Started ✍🏻

If you're new to open source, don't worry; we've made it easy to contribute.

Prerequisites

Ensure you have the following installed on your machine:

Steps to Contribute:-

Step 1. Fork the Repository

-> Fork the repo first

Step 2. Clone the forked Repository

git clone https://github.com/<your_github_username>/Library.git

Navigate to the Project Directory:

cd Library

Install Dependencies:

npm install

Run the Project Locally:

npm start

Step 3. Set Up Remotes

  • Add a reference (remote) to the original repository:
git remote add upstream https://github.com/ajaynegi45/Library.git
  • Add a reference (remote) to your forked repository:
git remote add origin https://github.com/<your_user_name>/Library.git

Step 4. Check Remotes

git remote -v

Step 5. Keep Your Local Copy Updated

git pull upstream main

Step 6. Create a New Branch

git checkout -b <your_branch_name>

Step 7. Making Changes

Perform your desired changes to the code base. Test the changes you have made using npm run dev or npm run dev -- --host.

Step 8. Track Changes

# Track all the changes
git status

# Add changes to the Index
git add .
or
git add <file_name>

Step 9. Commit Changes

git commit -m "Write a meaningful but small commit message"

Step 10. Push Changes

# Push Changes
git push -u origin <your_branch_name>

Compare and Create Pull Request

  • Click on "Compare And Pull Requests" 🔄
  • Ensure your pull request follows contribution guidelines.
  • Add an appropriate title and description to your pull request, explaining your changes with suitable explanations and screenshots 📝🖼️
  • Click on "Create Pull Request" to submit your contribution for review ✅

Code of Conduct 📃

Please feel free to take out time and read our Code Of Conduct

Feedback and Support 🎗️

We appreciate your feedback!

If you have any suggestions for how we can improve the project, please let us know. You can reach out to us on the project's issue tracker or through email.

Thank you ❤️

Thanks yet again for your interest in my Library project its means alot to me and happy coding ❤️