Skip to content

Latest commit

 

History

History
71 lines (45 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

71 lines (45 loc) · 2.87 KB
Raw

Contributing to vscode-k8s-pack

Thank you for your interest in contributing to vscode-k8s-pack! We appreciate your help in making this extension better.

Before you get started, please take a moment to read through this guide to understand how you can contribute effectively.

Table of Contents

Reporting Issues

If you encounter any issues with the extension or have suggestions for improvement, please follow these steps:

  1. Check the existing issues to see if the issue or suggestion has already been reported. If it has, you can add relevant information or subscribe to the issue for updates.
  2. If the issue or suggestion is not already reported, create a new issue. Please provide detailed information about the problem or feature request, including steps to reproduce, error messages, and the expected behavior.

Contributing Code

We welcome contributions in the form of bug fixes, enhancements, or new features. To contribute code to the extension, follow these steps:

Setting Up the Development Environment

  1. Fork the repository to your GitHub account.
  2. Clone your forked repository to your local development environment.
  3. Install Node.js if you haven't already.
    # Install development dependencies
    npm install

Making Changes

  1. Create a new branch for your changes. Use a descriptive name for your branch, such as feature/my-new-feature or bugfix/fix-issue-123.
  2. Make your changes and write clear, concise commit messages.

Testing

  1. Ensure that your changes pass the existing tests, and if applicable, add new tests for your code.
  2. Run the tests using the following command:
    npm test

Submitting Pull Requests

  1. Push your branch to your GitHub fork.
  2. Create a pull request against the master branch of the main repository.
  3. Provide a clear and informative title and description for your pull request, explaining the purpose and changes.

Our team will review your pull request and provide feedback. Once your changes are approved, they will be merged into the project.

Feature Requests

If you have an idea for a new feature or improvement, you can submit a feature request. Please create an issue and use the "feature request" label.

License

By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE.

Thank you for considering contributing to vscode-k8s-pack. Your involvement helps make this extension more useful for the community.