Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

71 lines (50 loc) · 2.21 KB
Raw

Contributing to MediMate

First of all, thank you for your interest in contributing to MediMate! Here’s how you can help:

Table of Contents

  1. Code of Conduct
  2. How Can I Contribute?
  3. Setting up the Project
  4. Pull Request Guidelines
  5. Bug Reports
  6. Feature Requests
  7. Community and Feedback

Code of Conduct

How Can I Contribute?

  • Bug Fixes: Found a bug? Check out our issue tracker to see if it's been reported, and feel free to submit a fix!
  • New Features: If you have an idea for a new feature, please submit it as a feature request before starting work.
  • Documentation: Help us by improving or expanding the documentation.

Setting up the Project

  1. Fork the repository and clone it to your local machine.

    git clone https://github.com/your-username/MediMate.git

  2. Install the project dependencies

    npm install

  3. Run the development server:

    npm start

  4. Make your changes and ensure everything works as expected.

Pull Request Guidelines

  • Ensure the code is clean, well-documented, and follows our style guidelines.
  • Write clear and concise commit messages.
  • Include relevant tests whenever applicable.
  • Before submitting, make sure that all tests pass. To create a pull request:

  1. Create a new branch

    git checkout -b feature/my-new-feature

  2. Push your changes to your forked repository:

    git push origin feature/my-new-feature

  3. Open a pull request from your branch to the main branch of the original repository.

Bug Reports

If you encounter any bugs, please open an issue on our issue tracker. Provide as much detail as possible, including steps to reproduce the issue.

Feature Requests

If you have a feature idea that would improve MediMate, you can also submit an issue. Please describe the feature in detail and explain how it would benefit the project.

Community and Feedback

We welcome all feedback and contributions. Feel free to join discussions in the issue tracker or contact us directly for any feedback or suggestions.