From 2ba18e010acf432e773f77d0d66a79491cd01509 Mon Sep 17 00:00:00 2001 From: Varsha567 <118257126+Varsha567@users.noreply.github.com> Date: Mon, 14 Oct 2024 23:27:27 +0530 Subject: [PATCH 1/2] Create CONTRIBUTING.md added contributing file --- CONTRIBUTING.md | 74 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e6e3f67 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,74 @@ +## Contributing to AquaGuardians +Weโ€™re excited to have you contribute to the **AquaGuardians** project! Follow these simple steps to get started: + +1. **๐Ÿด Fork the Repository** + - Go to the [repository page](https://github.com/tanishaness/AquaGuardians). + - Click the *Fork* button (top right) to create a copy in your GitHub account. + +2. **๐Ÿ’ป Clone Your Fork** + - Open your terminal and run: + ```bash + git clone https://github.com/your-username/AquaGuardians.git + ``` + - Replace `your-username` with your GitHub username. + +3. **๐ŸŒฟ Create a New Branch** + - Create a new branch for your work: + ```bash + git checkout -b your-branch-name + ``` + +4. **๐Ÿ› ๏ธ Make Your Changes** + - Open the project files in your code editor and implement your changes. + + +5. **โœ… Test Your Changes** + - Test your changes locally by running the application and verifying functionality. + 6. **๐Ÿ’ฌ Commit Your Changes** + - Once ready, commit your changes with a descriptive message: + ```bash + git add . + git commit -m "Added feature X or Fixed issue Y" + ``` + +7. **๐Ÿ“ค Push Your Changes** + - Push your changes to your forked repository: + ```bash + git push origin your-branch-name + ``` + +8. **๐Ÿ”„ Create a Pull Request (PR)** + - Go back to the original repository [here](https://github.com/tanishaness/AquaGuardians). + - Click the *Compare & pull request* button, write a short description of your changes, and submit the PR. + +9. **๐Ÿ”Ž Review Changes** + - The project manager will review your PR, and if approved, your request will be merged. + +--- +## ๐Ÿ“ Contribution Guidelines +- Keep your code clean and well-documented. +- Stick to best practices for the programming language you are contributing in. +- Respect the folder structure and organization of the repository. + +## ๐Ÿ† Contribution Points + +All tasks will be assigned various levels based on complexity and required skills. Each level provides different points: + +- **๐Ÿฅ‡ Level 1:** 10 Points +- **๐Ÿฅˆ Level 2:** 25 Points +- **๐Ÿฅ‰ Level 3:** 45 Points + +## ๐Ÿ’ป Code Style +Please follow the existing code style in the project. Consistent code style helps maintain readability and makes it easier for everyone to contribute. Ensure that your code passes all linting and formatting checks before submitting. + +## ๐Ÿงช Writing Tests +If youโ€™re adding a new feature or fixing a bug, please include tests to ensure that your changes donโ€™t break existing functionality. Tests should be written using the existing testing framework in the project. + +## ๐Ÿ“– Documentation +If your contribution changes how the package works, please update the relevant documentation. This includes updating comments, README files, and other markdown files as needed. + +## ๐Ÿž Reporting Issues +If you encounter any issues or have feature requests, please open an issue in the repository to discuss it. + + +Thank you for your contributions! Together, we can build something amazing. โœจ From f6f5fa1ec5246c61f5f72d2b43a508bf6dac0175 Mon Sep 17 00:00:00 2001 From: Varsha567 <118257126+Varsha567@users.noreply.github.com> Date: Mon, 14 Oct 2024 23:29:50 +0530 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e6e3f67..9b164a9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,8 @@ -## Contributing to AquaGuardians +## Contributing to โœจAquaGuardiansโœจ Weโ€™re excited to have you contribute to the **AquaGuardians** project! Follow these simple steps to get started: 1. **๐Ÿด Fork the Repository** - - Go to the [repository page](https://github.com/tanishaness/AquaGuardians). + - Go to the [repository page](https://github.com/sk66641/AquaGuardians). - Click the *Fork* button (top right) to create a copy in your GitHub account. 2. **๐Ÿ’ป Clone Your Fork** @@ -38,7 +38,7 @@ Weโ€™re excited to have you contribute to the **AquaGuardians** project! Follow ``` 8. **๐Ÿ”„ Create a Pull Request (PR)** - - Go back to the original repository [here](https://github.com/tanishaness/AquaGuardians). + - Go back to the original repository [here](https://github.com/sk66641/AquaGuardians). - Click the *Compare & pull request* button, write a short description of your changes, and submit the PR. 9. **๐Ÿ”Ž Review Changes**