Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (50 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

73 lines (50 loc) · 3.07 KB

Contributing to MEDICS Software

First of all, thank you for considering contributing to MEDICS Software! We are excited to have contributors like you who help make this project better. To make the process smoother, please follow these guidelines:

Table of Contents

Code of Conduct

We have a Code of Conduct that we expect all contributors to follow. Please be respectful, kind, and considerate in your interactions.

How to Contribute

Contributions to this project are always welcome! Here’s a simple process you can follow to contribute:

  1. Fork the repository.
  2. Clone your fork to your local machine.
  3. Create a new branch for your changes:
    • For features: feature/<your-feature-name>
    • For bug fixes: bugfix/<your-bugfix-name>
  4. Make your changes and commit them with a clear and concise message.
  5. Push your changes to your fork on GitHub.
  6. Open a Pull Request (PR) to the main repository with a description of your changes.

Issues

  • Bug reports and feature requests are always appreciated. If you find a bug, please open a new issue and provide as much information as possible:

    • A clear and concise title.
    • A description of the problem and steps to reproduce it.
    • Relevant screenshots or logs (if applicable).
    • The version of the software or platform you are using.

  • If you're submitting a feature request, be sure to explain the problem it solves and why you think the feature is beneficial.

Pull Requests

When submitting a pull request:

  1. Ensure your changes are tested and meet the guidelines in this document.
  2. Provide a detailed description of your changes in the PR message.
  3. If your pull request resolves an issue, reference the issue number in the description (e.g., "Fixes #42").
  4. Do not submit a pull request with uncommitted changes. Make sure your branch is up-to-date with the latest main branch before submitting.

Code Style

Please follow these code style guidelines to ensure consistency:

  • Use descriptive names for variables, functions, and classes.
  • Indent with spaces, not tabs (2 spaces for each level).
  • Keep line length under 80 characters.
  • Avoid redundant code and try to use existing functions where possible.
  • Use comments where necessary to explain complex code or logic.

Testing

Before submitting any changes, please ensure that:

  1. All unit tests pass.
  2. If you’ve added a new feature or fixed a bug, please add tests that cover your changes.
  3. Run the tests locally before submitting your pull request to ensure that everything works as expected.

Documentation

If your changes affect the documentation, please make sure to update the relevant sections in the README.md or other relevant files.

Thank You!

Thank you for your contribution to MEDICS Software. We appreciate your help in making this project even better!