Skip to content

Latest commit

 

History

History
100 lines (65 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

100 lines (65 loc) · 3.02 KB

Contributing to Metabob

Thank you for your interest in contributing to the Metabob project! We welcome and appreciate contributions from the community. Please read through this document to understand how you can contribute and ensure a smooth process for everyone involved.

Table of Contents

  1. Getting Started
  2. Reporting Bugs
  3. Feature Requests
  4. Submitting Changes
  5. Code Guidelines
  6. Documentation

Getting Started

To start contributing, first, fork the project's repository and clone your fork to your local machine:

git clone https://github.com/your-username/metabob.git
cd metabob

After that, follow these steps to set up your local environment:

  1. Install the dependencies:
npm install
  1. Build the project:
npm run build
  1. Open the project in VSCode:
code .
  1. Run the extension in a new window:

Press F5 or go to the Run tab in VSCode and click on Run and Debug.

Reporting Bugs

If you encounter any bugs or issues, please submit an issue on the project's GitHub issue tracker. When reporting a bug, please include the following information:

  • A clear and concise description of the bug
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Screenshots or logs, if applicable
  • Your environment (OS, VSCode version, extension version, etc.)

Feature Requests

We encourage you to share ideas for new features or improvements. To suggest a feature, please create an issue on the GitHub issue tracker with the label enhancement. Make sure to provide a clear and concise description of the proposed feature and explain why it would be beneficial to the project.

Submitting Changes

To submit your changes, please follow these steps:

  1. Create a new branch for your changes:
git checkout -b your-branch-name
  1. Commit your changes:
git commit -m "your commit message"
  1. Push your changes to your fork:
git push origin your-branch-name

  1. Create a pull request (PR) from your fork on GitHub. In your PR description, explain the purpose of your changes and any related issues.

  2. Wait for the maintainers to review your PR. They may request changes or further clarification before merging your changes.

Code Guidelines

Please follow these guidelines when contributing code:

  • Use clear, descriptive variable and function names
  • Add comments to explain complex or unintuitive code
  • Follow the existing code style and structure
  • Write unit tests for your changes, if applicable
  • Keep your changes focused and related to a single issue or feature

Documentation

If your changes require updates to the documentation, please update the relevant sections in the README.md or other documentation files. Additionally, if you find any errors or inconsistencies in the existing documentation, feel free to correct them.