Skip to content

Latest commit

 

History

History
152 lines (117 loc) · 5.36 KB

Contributors.md

File metadata and controls

152 lines (117 loc) · 5.36 KB
Raw

🌟Thank you for your interest in contributing to **DonorConnect!**🌟

Before you start contributing, please take a moment to review our guidelines below. If you have any questions, feel free to open an issue, and we'll be happy to assist you. 🚀

📊 Project Overview

DonorConnect is a platform designed to simplify the process of connecting donors with those in need of critical donations, including blood, organs, and resources. Your contributions will help make a difference in people's lives by improving features, fixing issues, and adding new functionalities.

🛠️ How to contribute:

  • Follow these steps to contribute to DonorConnect:

  1. Fork this Repository 🍴:
    Click the fork button at the top of the repository page to create a copy in your GitHub account.

  2. Clone the Repository to Your Local Machine 🧩:
    Open your terminal and clone the repo:

   
git clone https://github.com/Your-Username/DonorConnect.git

  1. Create a New Branch 🌿: Work on a separate branch for your feature or fix:

    git branch -c "Feature-Name"
git checkout Feature-Name

  2. Make Your Changes 🛠️: Add your code, test it locally, and ensure everything works.

  3. Add and Commit Your Changes 💬: Save your progress and commit with a meaningful message:

    git commit -m "Brief Description of Changes"

  4. Push Your Changes 🚢: Push your feature branch to your remote repository:

    git push origin Feature-Name

  5. Submit a Pull Request 🔥: Go to GitHub and create a Pull Request (PR) for review.

🎉 Welcome, Contributors!

We’re excited to have you on board. Whether you're fixing bugs 🐞, improving the UI 🎨, or adding new features 🆕, your contributions will help improve DonorConnect for users worldwide.

  • Here’s how you can start contributing:

  • Fork the Repository.

  • Create a New Feature Branch.

  • Make Meaningful Commits.

  • Push to GitHub.

  • Open a Pull Request (PR).

  • No contribution is too small! We appreciate every effort.

📜 Contribution Guidelines:

To maintain the quality of contributions to DonorConnect, please adhere to these guidelines:

1.Code Style: Ensure consistent code formatting and readability. Write clear, concise comments where needed.

2.Commit Messages: Use descriptive and meaningful messages. Briefly summarize the changes made.

3.Pull Requests: PRs should focus on a specific issue or feature. Provide detailed descriptions and reference any relevant issues.

4.Testing: Test your changes locally before submitting a PR. Ensure no existing features are broken.

5.Issue Tracker: Check the issue tracker before starting work to avoid duplicating efforts. Reference issues in your PRs to link relevant work.

💻 Technologies We Use

DonorConnect is built using modern technologies to ensure reliability and scalability:

Frontend: React ⚛️, JavaScript 🌐, HTML, CSS 🎨 Flutter & Dart: For cross-platform mobile development. Firebase: For authentication and backend services. Dart Cubit: For state management. Version Control: Git & GitHub 🛠️

🔄 Opening a Pull Request

To submit your PR:

  • Fork the repository.
  • Clone the repository to your local system.
git clone https://github.com/Your-Username/DonorConnect.git
  • Set up the project as detailed in Readme.md.
  • Make changes and test your code.
  • Follow the commit message and PR guidelines.
  • Submit your PR and await approval for merging.

🐞Issue Report Process

Encountered a bug or have a suggestion? Follow these steps to report it:

1.Check for Existing Issues: Review the Issue Tracker to see if it’s already reported. 2.Open a New Issue: If it hasn’t been raised, click "New Issue" and provide a detailed description. 3.Be Specific: Share clear steps to reproduce the issue and include screenshots/logs where applicable. 🖼️

✨Guidelines

  • Contributions such as low-code improvements, UI enhancements, feature implementations, or bug fixes are all valuable.
  • Ensure your fork is up-to-date with the main branch before making changes.
  • Interact courteously with other developers—be respectful and supportive.
  • Always test your code before submitting.
  • Use meaningful commit messages, prefixed with feat or fix.
  • Use separate branches for each PR you create.
git checkout -b <branch_name>
  • For PRs related to issues, mention the issue number in the title.
  • Provide a clear and descriptive title for your PR summarizing the changes.
  • Avoid spam PRs—contribute thoughtfully and follow the Code of Conduct.

🌐 Community and Communication

Feel free to engage with other contributors through GitHub Issues or Discussions for questions, feedback, or feature requests. 💬

📂 Project Structure

We follow a structured approach to ensure maintainability. If you make changes that impact the structure, be sure to document them.

💡 Need Inspiration?

Looking for ideas on what to contribute? Check the "Issues" tab for open tasks or suggest features that align with our mission. 🔍

✨ Join the Mission

We’re always looking for passionate contributors. Help us revolutionize donation management and make a positive impact in the world! 🌍

Contributors