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.

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

Added CONTRIBUTING.md #37

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
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
74 changes: 74 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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/sk66641/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/sk66641/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. ✨