Skip to content

Latest commit

 

History

History
168 lines (110 loc) · 6.03 KB

contributing.md

File metadata and controls

168 lines (110 loc) · 6.03 KB
Raw

Contributing to Uttarakhand Culture Preservation Project 🏔️✨

Introduction and Purpose 🌟

This project aims to create a web platform dedicated to preserving Uttarakhandi culture.

The objective of this project is to address the concerning trend of the younger generation losing touch with their cultural roots and to safeguard the traditional rituals, gods, and unique practices of Uttarakhand. We believe it's crucial to bridge this gap and ensure the preservation of our cultural identity for generations to come.

How to Contribute 👀

You can be a valuable part of our mission to showcase the rich culture, history, and nature of Uttarakhand. We welcome contributions in both code and non-code forms:

  • For Code Contributions:

    • 🐞 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.
    • You can assist in building the website. We are using React for the frontend and Java for the backend. Your expertise in these technologies is greatly appreciated.
    • To get involved, reach out to us, and we'll guide you on how to contribute to the codebase.

  • For Non-Code Contributions:

    • If you are not a coder, you can still make a significant impact:
      • 📄 Improve Documentation: Help improve project documentation.
      • Website Design: Share your creativity and design skills to help improve the look and feel of the website.
      • Content Gathering: Select a feature or aspect of Uttarakhand and start gathering authentic and insightful information. Please provide the sources or links from where you obtained the information. If the information is your own, make sure to mention.
      • Organize the information in a structured manner and create issues with your suggestions, designs, or content contributions..
      • If your contribution aligns with our mission to provide valuable and insightful content, we will gladly incorporate it into our website and give proper credit to you.

  • Help Us Find the Perfect Name for the Website:

    • Suggest a Name : We are in search of a unique and concise name for our website that reflects its purpose. We encourage you to suggest a name in Uttarakhandi language that is both meaningful and easy to remember. Your input is highly valued, and we'll consider all suggestions to choose the most fitting name. Please share your name suggestions via E-mail with "Website Name Suggestion" as the subject line.

We are committed to recognizing the efforts of our contributors. Soon, we will create a "Contributions" page on our website where we will showcase the photos and names of all our contributors.

Your participation, whether in code or content, will help us make this project more informative and enriching for all users.

Resources
Project Overview

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>/Uttarakhand-Culture-Preservation-Project

Navigate to the Project Directory:

cd Uttarakhand-Culture-Preservation-Project

Install Dependencies:

npm install

Run the Project Locally:

npm run dev

or

npm run host

Step 3. Set Up Remotes

  • Add a reference (remote) to the original repository:
git remote add upstream https://github.com/ajaynegi45/Uttarakhand-Culture-Preservation-Project.git
  • Add a reference (remote) to your forked repository:
git remote add origin https://github.com/<your_user_name>/Uttarakhand-Culture-Preservation-Project.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 Uttarakhand Culture Preservation Project its means alot to me and happy coding ❤️