Skip to content

Latest commit

 

History

History
34 lines (28 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

34 lines (28 loc) · 1.69 KB

Contributing to Light Command Palette

Introduction

Thank you for your interest in contributing to Light Command Palette! We value your contributions and want to make the process as easy and enjoyable as possible. This document outlines our guidelines for contributing.

How to Contribute

  • Report Bugs: If you find a bug, please open an issue in the GitHub repository, using the bug template. Be sure to describe the bug, steps to reproduce, and any other relevant information.
  • Feature Requests: Have an idea for a new feature or improvement? Open an issue using the feature request template.
  • Code Contributions:
    1. Fork the Repository: Start by forking the repository and cloning it to your local machine.
    2. Create a Branch: Create a branch for your changes. Use a clear and descriptive name for your branch.
    3. Make Changes: Make your changes in the branch. Be sure to follow the coding standards and guidelines of the project.
    4. Write Tests: If adding new features or fixing bugs, include tests to validate your changes.
    5. Run the linter: Make sure there are no errors.
    6. Submit a Pull Request: Push your changes to your fork and submit a pull request to the main repository. Provide a clear description of the changes and reference any related issues.
    7. Documentation: Improvements to documentation are always welcome. Whether it’s a typo correction or a new section, your help is appreciated.

Code of Conduct

Please adhere to the project's Code of Conduct. Respectful, collaborative behavior is expected from all contributors.

Development Setup

npm install

Running the linter

npm run lint

Running Tests

npm run test