Contribution Guidelines for Medical Ocean

Welcome to the Medical Ocean community! We’re excited that you’re interested in contributing to our open-source healthcare technology projects. These guidelines will help you navigate the contribution process.

Table of Contents

1. Code of Conduct
2. Getting Started
3. How to Contribute
4. Coding Standards
5. Commit Messages
6. Pull Request Process
7. Reporting Bugs
8. Suggesting Enhancements
9. Community

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it before contributing.

Getting Started

1. Fork the repository on GitHub.
2. Clone your fork locally: git clone https://github.com/yourusername/repo-name.git
3. Create a new branch for your feature or bug fix: git checkout -b feature/your-feature-name
4. Make your changes and commit them with a clear commit message.
5. Push your changes to your fork: git push origin feature/your-feature-name
6. Create a pull request from your fork to the main repository.

How to Contribute

• Code: Implement new features or fix bugs.
• Documentation: Improve or create new documentation.
• Testing: Write and improve tests.
• Bug reports: Submit detailed bug reports.
• Feature requests: Suggest new features or improvements.

Coding Standards

• Follow the existing code style in the project.
• Write clear, commented, and testable code.
• Ensure your code adheres to our linting rules.
• Write meaningful variable and function names.
• Keep functions small and focused on a single task.

Commit Messages

• Use the present tense (“Add feature” not “Added feature”).
• Use the imperative mood (“Move cursor to…” not “Moves cursor to…").
• Limit the first line to 72 characters or less.
• Reference issues and pull requests liberally after the first line.

Pull Request Process

1. Ensure your code adheres to the project’s coding standards.
2. Update the README.md with details of changes, if applicable.
3. Add tests for new features or bug fixes.
4. Ensure the test suite passes.
5. Make sure your code lints without errors.
6. Include a clear description of the changes in your pull request.
7. Link any relevant issues in the pull request description.

Reporting Bugs

• Use the GitHub Issues tracker.
• Describe the bug in detail.
• Include steps to reproduce the bug.
• Specify your environment (OS, browser, etc.).
• If possible, provide a minimal code example that reproduces the bug.

Suggesting Enhancements

• Use the GitHub Issues tracker.
• Provide a clear description of the enhancement.
• Explain why this enhancement would be useful to most users.
• List some examples of how this enhancement would be used.

Community

• Join our Slack channel for discussions.
• Follow us on Twitter for updates.
• Subscribe to our newsletter for important announcements.

Thank you for contributing to Medical Ocean! Your efforts help improve healthcare technology for everyone.