Skip to content

Latest commit

 

History

History
103 lines (64 loc) · 3.77 KB

CONTRIBUTING.md

File metadata and controls

103 lines (64 loc) · 3.77 KB

🌟 Hacktoberfest 2024 Contribution Guide for Medi-Connect 🏥

Welcome to the Medi-Connect repository! We are thrilled that you're interested in contributing to this project. Medi-Connect aims to streamline hospital appointments and OPD management. This contribution guide will walk you through setting up the project, making your contributions count for Hacktoberfest 2024, and improving healthcare accessibility through technology! 🌐💻

Deployed Project: Medi-Connect

🚀 How to Contribute

We welcome all contributors! Whether you're a seasoned developer or a newbie in open source, follow these steps to contribute:

1. Fork the Repository

Click the Fork button at the top-right corner of this repository to create your own copy.

2. Clone Your Fork

Once you have forked the repository, clone it to your local machine:

git clone https://github.com/Luson045/medi-connect.git

3. Create a New Branch

Always create a new branch for your changes:

git checkout -b your_branch

4. Do staging in it

Make Your Changes

git add .

5. ESLint and Prettier Check

This will help maintain code quality by enforcing consistent styling and catching potential errors early in the development process. If there are ESLint warnings in the staged files you won't be able to make a commit. You can manually check if there are any ESLint warnings in your staged files. You can do so using below command.

npx lint-staged

6. Commit Your Changes:

git commit -m "Relevant message"

7. Push to Your Branch:

git push origin your_branch

8. Create a Pull Request:

Go to your forked repository on GitHub and create a pull request to the main repository and we"ll merge it as soon as PR is reviewed throughly.

🌟 What Can You Contribute?

There are several ways you can help improve Medi-Connect:

  • 🛠️ Bug Fixes: Found a bug? We’d love your help fixing it.
  • 📦 New Features: Have a cool idea to make the platform better? Add it!
  • 📜 Documentation: If you think our docs can be improved, feel free to enhance them.
  • 🧪 Testing: Writing tests and ensuring code quality is crucial.
  • 💡 Ideas & Discussions: You can open an issue to discuss new features or improvements.

📜 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.
  5. Environment Setup: Make sure your .env file and MongoDB connection are properly configured.

🎉 Hacktoberfest 2024 Participation

We are proud participants of Hacktoberfest 2024! Contribute between October 1st and October 31st and get the chance to earn exclusive Hacktoberfest swag 🏅. Here's how to get started:

Make sure your PRs are:

  • Focused: Try to keep them small and meaningful.
  • High-Quality: Test your changes and follow best practices.

🎯 Key Project Links

Happy Coding 💻 and we look forward to your contributions during Hacktoberfest 2024! 🎃