Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
132 lines (93 loc) · 4.68 KB

CONTRIBUTING.md

File metadata and controls

132 lines (93 loc) · 4.68 KB

Contributing to ros2_medkit_web_ui

Thanks for your interest in contributing to ros2_medkit_web_ui! This guide explains how to report issues, suggest features, and contribute code.

How to Report Issues

Did you find a bug?

  • Ensure the bug was not already reported by searching Issues
  • If you can't find an existing issue, open a new one and select the Bug report template
  • Fill in all sections of the template:
    • Steps to reproduce - numbered steps to recreate the issue
    • Expected behavior - what you expected to happen
    • Actual behavior - what actually happened, including error messages or stack traces
    • Environment - ros2_medkit_web_ui version, browser, OS
    • Additional information - logs, snippets, or screenshots if helpful

Do you want to suggest a feature or improvement?

  • Check if the feature has already been suggested in Issues
  • If not, open a new issue and select the Feature request / General issue template
  • Fill in all sections:
    • Proposal - describe the change or feature you'd like to see
    • Motivation - why is this important? Who does it benefit?
    • Alternatives considered - other options or implementations you considered
    • Additional context - any other context or screenshots

How to Contribute Code

Development Workflow

  1. Fork the repository and clone your fork locally
  2. Create a branch from main with a descriptive name:
    • feature/short-description for new features
    • fix/short-description for bug fixes
    • docs/short-description for documentation changes
  3. Install dependencies: npm install
  4. Make your changes following the project's coding standards
  5. Test your changes locally: npm run dev
  6. Run linting: npm run lint
  7. Build the project: npm run build
  8. Commit your changes with clear, descriptive commit messages
  9. Push your branch to your fork
  10. Open a Pull Request against the main branch of this repository

Commit Messages

  • Use clear and descriptive commit messages
  • Start with a verb in imperative mood (e.g., "Add", "Fix", "Update", "Remove")
  • Keep the first line under 72 characters
  • Add a blank line followed by a more detailed explanation if needed

Examples:

Add server connection dialog with URL validation

Fix entity tree not expanding on click

Update documentation for Docker deployment

Build and Test Requirements

Before opening or updating a Pull Request, you must:

  1. Install dependencies:

    npm install

  2. Run linting:

    npm run lint

  3. Build the project successfully:

    npm run build

  4. Ensure the app works locally:

    npm run dev

Pull Request Checklist

Before submitting your PR, ensure:

  • Code follows the repository's style and conventions
  • Build succeeds without warnings
  • Linting passes
  • New functionality has been tested manually
  • Documentation is updated where applicable
  • PR description clearly explains what changed and why
  • Related issue is referenced (e.g., "Fixes #123")

Code Review Process

  • The project maintainers will review pull requests as time permits
  • Address review feedback promptly
  • Keep discussions professional and constructive
  • Be patient - maintainers may need time to review

What NOT to Contribute

  • Purely cosmetic changes that don't add functionality (whitespace, formatting without other changes)
  • Large refactors without prior discussion - open an issue first
  • Breaking changes without coordination with maintainers
  • Code that doesn't pass linting or breaks existing functionality

Questions and Help

  • For questions about using ros2_medkit_web_ui, open a Discussion or an Issue with the question label
  • For questions about contributing, feel free to ask in your PR or Issue
  • For security vulnerabilities, see SECURITY.md

Code of Conduct

By contributing to ros2_medkit_web_ui, you agree to abide by our Code of Conduct. Please be respectful and considerate in all interactions.

License

By contributing to ros2_medkit_web_ui, you agree that your contributions will be licensed under the Apache License 2.0.

Thank you for improving ros2_medkit_web_ui! We value contributions of all sizes - from typo fixes to major features. 🚀