✨AquaGuardians✨

Table of Contents🧾

• Introduction📌
• Technology Used🚀
• Featured in🏆
• Overview⭐
• Getting Started💥
• Project Contributors🫂
• Contribution Guidelines👇
• Code of conduct💻
• Contributing is fun🧡

Introduction📌

AquaGuardians is an interactive educational game that teaches players the importance of sustainable groundwater management through interactive puzzles

Technology Used🚀

Featured in🏆

Event Logo	Event Name	Event Description
	GirlScript Summer of Code 2024 - Extended	GirlScript Summer of Code is a three-month-long Open Source Program conducted every summer by GirlScript Foundation. It is an initiative to bring more beginners to Open-Source Software Development.

(back to top)

Overview⭐

Live Project -- https://sk66641.itch.io/aquaguardians/

Getting Started💥

Guidelines

• Before creating an issue, use the search feature to check if a similar issue already exists.
• Issues are assigned on the basis of “first come, first served.” Others may get a chance if the issue gets stale and the assignee is inactive for over a week.
• Do not create a Pull Request until the issue has been assigned to you.
• Always mention the issue number for which the Pull Request is being created. You can use one of the following keywords in your PR description or comment to reference the issue: closes #123 fixes #123 resolves #123 implements #123
• Remember to follow this practice to streamline collaboration and keep the project organized! 😊

Contributing to AquaGuardians 🎉

Thank you for your interest in contributing to AquaGuardians! We welcome contributions and are excited to work with the community. This guide will help you get started. 😊

Fork the Repository 🍴

1. Navigate to the AquaGuardians.
2. Click the "Fork" button at the top right of the page.

Clone Your Fork 💻

1. Open GitHub Desktop.
2. Click on "File" > "Clone Repository".
3. Select the forked repository and choose the local path where you want to save it.
4. Click "Clone".

Create a Branch 🌿

1. In GitHub Desktop, click on "Current Branch" and select "New Branch".
2. Name your branch descriptively, e.g., feature-add-animation.
3. Click "Create Branch".

Making Changes ✍️

Open the Repository in Your Editor 🖥️

1. In GitHub Desktop, click on "Repository" > "Open in Visual Studio Code" (or your preferred editor).

Implement Your Changes 🔧

1. Make your changes in the code editor.
2. Save your changes.

Commit Your Changes 💾

1. In GitHub Desktop, you should see your changes listed.
2. Enter a summary for your commit and a detailed description if necessary.
3. Click "Commit to your-branch-name".

Push Your Changes 📤

1. Click "Push origin" in GitHub Desktop to push your changes to your forked repository on GitHub.

Submit a Pull Request 🔄

1. Navigate to your forked repository on GitHub.
2. Click on the "Compare & pull request" button.
3. Ensure the base repository is sk66641/AquaGuardians and the base branch is main.
4. Add a title and description for your pull request.
5. Click "Create pull request".

Code Review and Feedback 📝

1. The repository maintainers will review your pull request.
2. You may be asked to make additional changes.
3. Once approved, your pull request will be merged into the main branch.

Syncing Your Fork 🔄

To keep your fork up-to-date with the original repository:

1. Add the original repository as a remote:

   git remote add upstream https://github.com/sk66641/AquaGuardians.git

2. Fetch the latest changes:

   git fetch upstream

3. Merge the changes into your local branch:

   git checkout main
   git merge upstream/main

4. Push the updates to your fork:

   git push origin main

Additional Notes 📝

• Be Descriptive: When naming branches, committing changes, and submitting pull requests, be as descriptive as possible. Clear names and messages help maintainers understand the purpose of your changes. 🗂️
• Follow the Code Style: Ensure your code follows the project's coding standards. Consistency in code style helps maintain readability and maintainability. ✨
• Testing: Thoroughly test your changes to make sure they do not break existing functionality. Writing tests for new features is highly encouraged. 🧪

How to Report Bugs 🐛

1. Check Existing Issues: Before opening a new issue, check if the bug has already been reported.
2. Open a New Issue: If the bug is new, open an issue on the Issues page.
3. Provide Details: Include as much information as possible, such as steps to reproduce the bug, expected behavior, and screenshots if applicable.

How to Request Enhancements 🌟

1. Check Existing Issues: Before suggesting a new feature, check if it has already been proposed.
2. Open a New Issue: If the feature is new, open an issue on the Issues page.
3. Provide Details: Clearly describe the enhancement and why it would be beneficial.

Thank you for contributing to the AquaGuardians! Your efforts help make this project better for everyone. 🎉🚀

Project Contributors🫂

Thanks to these wonderful people: ✨

Contribution Guidelines👇

To maintain quality and consistency, please adhere to the following guidelines:

1. Code Style: Follow the coding style used throughout the project. Clean, readable code with comments is always appreciated.
2. Commits: Write meaningful commit messages.
3. Pull Requests: Make sure PRs are focused, well-explained, and reference any issues they address.
4. Testing: Ensure that your changes are well-tested locally and don’t break existing functionality.

Code of conduct💻

1. Be respectful: Be open-minded and welcoming to new users and collaborators. Respect differing opinions and experiences.
2. Be constructive: Contribute positively to discussions by improving them in some way.
3. Be trustworthy: Be honest and don't intentionally mislead others.
4. Be empathetic: Demonstrate kindness and empathy toward others.
5. Be responsible: Accept responsibility for mistakes and apologize to those affected.
6. Avoid harassment: Don't use sexualized language or imagery, make personal attacks, or publish others' private information.

Contributing is fun🧡

Contributions of any kind from anyone are always welcome🌟!!

Give it a 🌟 if you ❤ it. Happy Coding👨‍💻

(back to top)