Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Done some enhancements and also added some new sections #179

Closed
wants to merge 1 commit into from
Closed

Done some enhancements and also added some new sections #179

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
228 changes: 174 additions & 54 deletions contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ We're all about **quality over quantity** here, so even your smallest, meaningfu

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

### For Code Contributions 💻
## For Code Contributions 💻

- **🐞 Found a Bug?**
Open an issue with details or, even better, submit a pull request with the fix.
Expand All @@ -28,7 +28,7 @@ You can get involved in **code** or **non-code** contributions. Here’s how:
- **💻 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 📄
## For Non-Code Contributions 📄

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

Expand All @@ -42,13 +42,73 @@ You don’t need to be a developer to contribute! Here's how you can help:
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. 📝
<a href="https://ajaynegi.notion.site/Resources-f92bcb910d0544a1a8db50cc3ef79cfe" target="_blank">Explore this resource also for gathering cultural information</a>


- **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](https://github.com/ajaynegi45/Uttarakhand-Culture-NewUI/issues/new?assignees=&labels=status%3A+awaiting+triage&projects=&template=feature_request.yml&title=%5BFEATURE%5D+%3Cbrief+description%3E) or **[Email](mailto:[email protected])** 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!

<br/>
<br>

# Code of Conduct 📃

We value respect and inclusivity. Please make sure to read our **[Code of Conduct](https://github.com/ajaynegi45/Uttarakhand-Culture-NewUI/blob/main/code_of_conduct.md)** before contributing.

<br>

# Need Help with the Basics? 🤔

If you're new to Git and GitHub, no worries! Here are some useful resources:

- [Forking a Repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
- [Cloning a Repository](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request)
- [How to Create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github)
- [Getting Started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6)
- [Learn GitHub from Scratch](https://docs.github.com/en/get-started/start-your-journey/git-and-github-learning-resources)

<br>

# Project Structure 📂

```bash
UTTARAKHAND-CULTURE-NEWUI/
├── .github/ # GitHub-related configurations such as workflows, issue templates, etc
│
├── .idea/ # All the XML files are stored here
│
├── Design/ # PDF of the homepage is stored here
│
├── drizzle/ # All the databases are stored here
│
├── public/ # All the images used as reference for the public are included here
│
├── src/ # All the typescript files are included here
│
├── .env.sample
│
├── .eslintrc.json
│
├── .gitignore
│
├── code_of_conduct # Some rules for the contributors
│
├── contributing.md # Instructions for the contributors
├──
├── drizzle.config.ts
├──
├── next-auth.d.ts
├──
├── next.config.mjs
├──
├── package-lock.json
├──
├── package.json
├──
├── README.md # Some basic instructions before starting contribution
├──
├── tsconfig.json
```

<br>

# Getting Started ✍🏻

Expand All @@ -68,95 +128,155 @@ And hey, while you’re at it, don’t forget to:
- Follow **Uttarakhand Culture** on [LinkedIn](https://www.linkedin.com/company/uttarakhandculture) to stay updated with the latest news, events, and cultural insights.
- ⭐ Star the [repository](https://github.com/ajaynegi45/Uttarakhand-Culture-NewUI) and show your support for preserving this beautiful heritage!


## How to Contribute:
Uttarakhand-Culture-NewUI

#### Step 1. Fork the Repository 🍴
<br>

First, **[Fork this repo](https://github.com/ajaynegi45/Uttarakhand-Culture-Preservation-Project.git)** to your GitHub account.
# First Pull Request ✨

#### Step 2. Clone the Forked Repo 💾
1. **Star this repository**
Click on the top right corner marked as **Stars** at last.

```bash
git clone https://github.com/<your_github_username>/Uttarakhand-Culture-NewUI.git
cd Uttarakhand-Culture-NewUI
npm install
```
2. **Fork this repository**
Click on the top right corner marked as **Fork** at second last.

#### Step 3. Run the Project Locally 🚀
3. **Clone the forked repository**

```bash
npm run dev
git clone https://github.com/<your-github-username>/Uttarakhand-Culture-NewUI.git
```

4. **Navigate to the project directory**

#### Step 4. Set Up Remotes 🔄

Add a reference to the original repository:
```bash
git remote add upstream https://github.com/ajaynegi45/Uttarakhand-Culture-NewUI.git
cd Uttarakhand-Culture-NewUI
```

Add a reference to your forked repo:
5. **Create a new branch**

```bash
git remote add origin https://github.com/<your_github_username>/Uttarakhand-Culture-NewUI.git
git checkout -b <your_branch_name>
```

#### Step 5. Keep Your Local Copy Updated 🔄
6. **To make changes**

```bash
git pull upstream main
git add .
```

#### Step 6. Create a new branch for your feature or bugfix 🌿
7. **Now to commit**

```bash
git checkout -b feature/feature_name
git commit -m "add comment according to your changes or addition of features inside this"
```

#### Step 7. Make Your Changes ✏️
8. **Push your local commits to the remote repository**

Apply the changes you wish to contribute, and test them using:
```bash
npm run dev
git push -u origin <your_branch_name>
```

#### Step 8. Track Your Changes 🕵️
9. **Create a Pull Request**

```bash
git status
git add .
```
10. **Congratulations! 🎉 you've made your contribution**

#### Step 9. Commit Your Changes 💬
<br>

```bash
git commit -m "Meaningful commit message"
```
# Alternatively, contribute using GitHub Desktop 🖥️

#### Step 10. Push Your Branch 🚀
1. **Open GitHub Desktop:**
Launch GitHub Desktop and log in to your GitHub account if you haven't already.

```bash
git push -u origin <your_branch_name>
```
2. **Clone the Repository:**
- If you haven't cloned the Project-Guidance repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
- Choose the Project-Guidance repository from the list of repositories on GitHub and clone it to your local machine.

#### Step 11. Submit Your Pull Request 🔄
3.**Switch to the Correct Branch:**
- Ensure you are on the branch that you want to submit a pull request for.
- If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

- 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!
4. **Make Changes:**
- Make your changes to the code or files in the repository using your preferred code editor.

## Code of Conduct 📃
5. **Commit Changes:**
- In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
- Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to <branch-name>" button to commit your changes to the local branch.

We value respect and inclusivity. Please make sure to read our **[Code of Conduct](https://github.com/ajaynegi45/Uttarakhand-Culture-NewUI/blob/main/code_of_conduct.md)** before contributing.
6. **Push Changes to GitHub:**
- After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

7. **Create a Pull Request:**
- Go to the GitHub website and navigate to your fork of the Project-Guidance repository.
- You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

8. **Review and Submit:**
- On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
- Once you're satisfied, click the "Create pull request" button to submit your pull request.

9. **Wait for Review:**
Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the Project-Guidance repository.

<br>

# For Help And Support 💬

- Admin :- Ajay Negi
- Contact :- [Discord](https://discord.gg/https://discord.gg/68De2PvDdR)

<br>

# Good Coding Practices 🧑‍💻

1. **Follow the Project's Code Style**

- Maintain consistency with the existing code style (indentation, spacing, comments).
- Use meaningful and descriptive names for variables, functions, and classes.
- Keep functions short and focused on a single task.
- Avoid hardcoding values; instead, use constants or configuration files when possible.

2. **Write Clear and Concise Comments**

- Use comments to explain why you did something, not just what you did.
- Avoid unnecessary comments that state the obvious.
- Document complex logic and functions with brief explanations to help others understand your thought -process.

3. **Keep Code DRY (Don't Repeat Yourself)**

- Avoid duplicating code. Reuse functions, methods, and components whenever possible.
- If you find yourself copying and pasting code, consider creating a new function or component.

4. **Write Tests**

- Write unit tests for your functions and components.
- Ensure your tests cover both expected outcomes and edge cases.
- Run tests locally before making a pull request to make sure your changes don’t introduce new bugs.

5. **Code Reviews and Feedback**

- Be open to receiving constructive feedback from other contributors.
- Conduct code reviews for others and provide meaningful suggestions to improve the code.
- Always refactor your code based on feedback to meet the project's standards.

<br>

# Pull Request Process 🚀

When submitting a pull request, please adhere to the following:

1. **Self-review your code** before submission. 😀
2. Include a detailed description of the functionality you’ve added or modified.
3. Comment your code, especially in complex sections, to aid understanding.
4. Add relevant screenshots to assist in the review process.
5. Submit your PR using the provided template and hang tight; we'll review it as soon as possible! 🚀

<br>

## Feedback and Support 🎗️
# 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](https://github.com/ajaynegi45/Uttarakhand-Culture-NewUI/issues/new/choose).

---
<br/>
<br>

## Thank You ❤️
# 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! 🌄
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! 🌄