Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (48 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

68 lines (48 loc) · 2.25 KB

Contributing to Hyperion Plugin Core

Thank you for your interest in contributing to Hyperion Plugin Core! This document provides guidelines and instructions for contributing to this project.

Code of Conduct

By participating in this project, you agree to maintain a respectful and inclusive environment for everyone.

How to Contribute

Reporting Bugs

If you find a bug, please create an issue on the GitHub repository with the following information:

  • A clear, descriptive title
  • A detailed description of the issue
  • Steps to reproduce the bug
  • Expected behavior
  • Actual behavior
  • Any relevant logs or screenshots
  • Your environment (Node.js version, OS, etc.)

Suggesting Enhancements

We welcome suggestions for enhancements! Please create an issue on the GitHub repository with:

  • A clear, descriptive title
  • A detailed description of the proposed enhancement
  • Any relevant examples or use cases
  • If applicable, examples of how the enhancement would be used in code

Pull Requests

  1. Fork the repository
  2. Create a new branch for your feature or bugfix (git checkout -b feature/your-feature-name or git checkout -b fix/your-bugfix-name)
  3. Make your changes
  4. Add or update tests as necessary
  5. Ensure all tests pass
  6. Update documentation as needed
  7. Commit your changes with clear, descriptive commit messages
  8. Push your branch to your fork
  9. Submit a pull request to the main repository

Pull Request Guidelines

  • Follow the existing code style
  • Include JSDoc comments for all public APIs
  • Update the README.md if necessary
  • Update the CHANGELOG.md with your changes under the "Unreleased" section
  • Make sure your code passes all tests

Development Setup

  1. Clone the repository
  2. Install dependencies with npm install
  3. Build the project with npm run build

Coding Standards

  • Use TypeScript for all code
  • Follow the existing code style
  • Add JSDoc comments for all public APIs
  • Use meaningful variable and function names
  • Write unit tests for new functionality

License

By contributing to Hyperion Plugin Core, you agree that your contributions will be licensed under the project's MIT License.