Skip to content

Latest commit

 

History

History
162 lines (102 loc) · 6.8 KB

contributing.md

File metadata and controls

162 lines (102 loc) · 6.8 KB
Raw

Contributing to the Uttarakhand Culture 🏔️✨

Introduction and Purpose 🌟

Welcome to the Uttarakhand Culture Project! This platform is dedicated to preserving and celebrating the rich cultural heritage of Uttarakhand. We aim to address the growing concern of the younger generation losing touch with their cultural roots by safeguarding the traditional rituals, deities, and unique practices of Uttarakhand. Together, we can ensure this cultural treasure is passed down to future generations. 🌿

Whether you're a coder or a cultural enthusiast, we need your help! Your contributions—big or small—are invaluable in building this platform. Let’s work together to bridge the gap and keep our heritage alive! 🌱✨

If you have any questions, doubts, or suggestions about contributing (or anything else), feel free to ping me on LinkedIn or Twitter anytime. I'll do my best to reply as quickly as possible.

We're all about quality over quantity here, so even your smallest, meaningful contribution will make a bigger impact than something large but less thoughtful. Let's create something special together! 🙌

How You Can Contribute 👀

You can get involved in code or non-code contributions. Here’s how:

For Code Contributions 💻

  • 🐞 Found a Bug?
    Open an issue with details or, even better, submit a pull request with the fix.

  • 🎉 Got a Feature Idea?
    Share your feature ideas in an issue to discuss or go ahead and submit a pull request implementing the feature!

  • 💅 Want to Improve the User Interface?
    If you have design skills or ideas, we welcome UI improvements! Propose changes in layout, color scheme, or fonts—just remember, we love minimal and clean designs.

  • 💻 Building the Platform?
    We’re using Nextjs with TypeScript for the frontend and the backend**. If you have expertise in these technologies, your contributions are highly appreciated. Need help getting started? Just reach out!

For Non-Code Contributions 📄

You don’t need to be a developer to contribute! Here's how you can help:

  • Improve Documentation
    Help us write or refine our documentation, making it easier for others to join the project.

  • Contribute to Website Design
    Your creativity is welcome! Share design suggestions to improve the website’s aesthetic.

  • Gather Cultural Content
    Choose an aspect of Uttarakhand’s culture—whether it’s history, traditions, or natural beauty—and gather authentic information. Be sure to cite your sources. If the information is personal or local knowledge, please mention that too. 📝
    Explore this resource also for gathering cultural information

  • Suggest a Name for the Website
    We're still on the hunt for the perfect name! We want something meaningful in the local language that reflects the website's mission. Got an idea? Share it via opening an issue or Email with the subject line “Website Name Suggestion.” Your creativity could name this entire project!

Contributor Spotlight: We value every contribution! To celebrate your efforts, we'll feature your name and photo on a dedicated "Contributors" page, where you'll receive full recognition for your impact on this project. Your contributions will help us preserve Uttarakhand's rich culture, and we're excited to share your work with the world!


Getting Started ✍🏻

Even if you’re new to open source, contributing is easy! Follow the steps below to join us:

Prerequisites 🌐

Before diving into the project, make sure you’ve got the following tools ready to go on your machine:

  • npm (v6 or higher)
  • Node.js (v18.17.1 or higher)
  • Don't use Tailwind CSS
  • Ask before using any other dependencies.

And hey, while you’re at it, don’t forget to:

  • Follow Uttarakhand Culture on LinkedIn to stay updated with the latest news, events, and cultural insights.
  • ⭐ Star the repository and show your support for preserving this beautiful heritage!

How to Contribute:

Step 1. Fork the Repository 🍴

First, Fork this repo to your GitHub account.

Step 2. Clone the Forked Repo 💾

git clone https://github.com/<your_github_username>/Uttarakhand-Culture-NewUI.git
cd Uttarakhand-Culture-NewUI
npm install

Step 3. Run the Project Locally 🚀

npm run dev

Step 4. Set Up Remotes 🔄

Add a reference to the original repository:

git remote add upstream https://github.com/ajaynegi45/Uttarakhand-Culture-NewUI.git

Add a reference to your forked repo:

git remote add origin https://github.com/<your_github_username>/Uttarakhand-Culture-NewUI.git

Step 5. Keep Your Local Copy Updated 🔄

git pull upstream main

Step 6. Create a new branch for your feature or bugfix 🌿

git checkout -b feature/feature_name

Step 7. Make Your Changes ✏️

Apply the changes you wish to contribute, and test them using:

npm run dev

Step 8. Track Your Changes 🕵️

git status
git add .

Step 9. Commit Your Changes 💬

git commit -m "Meaningful commit message"

Step 10. Push Your Branch 🚀

git push -u origin <your_branch_name>

Step 11. Submit Your Pull Request 🔄

  • Head over to your fork on GitHub.
  • Click "Compare & Pull Request".
  • Ensure your PR follows contribution guidelines and includes screenshots or explanations.
  • Click "Create Pull Request" to submit your contribution for review!

Code of Conduct 📃

We value respect and inclusivity. Please make sure to read our Code of Conduct before contributing.

Feedback and Support 🎗️

We’re always open to feedback! If you have any suggestions for improving the project, let us know by opening an issue.


Thank You ❤️

Thank you for showing interest in the Uttarakhand Culture Preservation Project! Your contributions, whether in code or content, help make this platform more enriching for everyone. Let's preserve the beauty of Uttarakhand together! 🌄