Skip to content

Latest commit

 

History

History
96 lines (69 loc) · 3.44 KB

CONTRIBUTING.md

File metadata and controls

96 lines (69 loc) · 3.44 KB

Contributing to Advanced Hospital Management System

We're glad you're interested in contributing to the Advanced Hospital Management System! This document provides guidelines for contributions to help maintain code quality and consistency.

Table of Contents

  1. Getting Started
  2. How to Contribute
  3. Coding Standards
  4. Submitting Changes
  5. Reporting Bugs
  6. Requesting Features
  7. Code of Conduct

Getting Started

  1. Fork the repository on GitHub: https://github.com/yazdanhaider/Hospital-Management/
  2. Clone your fork locally: 
    git clone https://github.com/your-username/Hospital-Management.git
  3. Create a branch for your changes: 
    git checkout -b feature/your-feature-name

How to Contribute

  1. Make Changes: Develop your changes in the feature branch.

  2. Test the Application:

    • Run the application locally.
    • Verify that existing features work correctly.
    • Test your new changes thoroughly.

  3. Ensure Adherence to Coding Standards: Follow the coding guidelines provided below.

  4. Commit Changes: Use a descriptive commit message.

  5. Push to Your Fork: Push the changes to your GitHub fork:

    git push origin feature/your-feature-name

  6. Open a Pull Request: Submit a pull request to the main repository.

Coding Standards

  • General Guidelines:

    • Use meaningful and descriptive names for variables and functions.
    • Follow consistent indentation (recommended: 2 spaces).
    • Add comments for complex or critical sections of code.
    • Make sure the code is compatible with modern web browsers.

  • HTML:

    • Use semantic HTML5 elements where appropriate.
    • Maintain proper tag nesting and closing.

  • CSS:

    • Follow a consistent naming convention for class and ID selectors.
    • Group related CSS properties together.

  • JavaScript (React):

    • Use ES6+ standards where applicable.
    • Avoid global variables; use modules or components to en

Submitting Changes

  1. Push Changes to Your Fork: Push the branch to your forked repository.
  2. Open a Pull Request: Submit a pull request with a clear description of the changes.
  3. Provide Details: Explain the problem solved or feature added and reference relevant issue numbers if applicable.
  4. Review Feedback: Be prepared to make additional changes if requested.

Reporting Bugs

  1. Check Existing Issues: Look at the Issues section to see if the bug has already been reported.
  2. Create a New Issue: If not found, create a new issue with a clear title and detailed description.
  3. Include Steps to Reproduce: Provide steps and any relevant code snippets.

Requesting Features

  1. Review Existing Feature Requests: Check if the feature has already been suggested.
  2. Open a New Feature Request: If not, submit a new feature request with a clear description and potential benefits.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct:

  1. Be respectful and inclusive.
  2. Exercise consideration and respect in your speech and actions.
  3. Attempt collaboration before conflict.
  4. Refrain from demeaning, discriminatory, or harassing behavior and speech.
  5. Be mindful of your surroundings and of your fellow participants.

Thank you for contributing to the Advanced Hospital Management System!