Skip to content

Latest commit

 

History

History
121 lines (76 loc) · 4.25 KB

CONTRIBUTING.md

File metadata and controls

121 lines (76 loc) · 4.25 KB

Contributing to VSCode Bookmark

Thank you for your interest in contributing to the VSCode Bookmark extension! By contributing, you help improve the experience for all users. Please take a few minutes to read through the following guidelines to ensure your contributions are aligned with the project's goals.

Table of Contents

  1. How to Contribute
  2. Reporting Bugs
  3. Suggesting Features
  4. Contributing Code
  5. Code Standards
  6. Pull Requests
  7. License

How to Contribute

You can contribute to the VSCode Bookmark extension in several ways:

  • Reporting bugs
  • Suggesting new features
  • Writing or improving documentation
  • Contributing code

Please ensure that any contributions align with the extension's purpose of providing efficient bookmark functionality within the VSCode environment.

Reporting Bugs

If you encounter any issues with the extension, feel free to open a new issue. When doing so, make sure to include the following details:

  • Clear title and description: A concise summary of the bug.
  • Steps to reproduce: A detailed set of steps to reproduce the issue.
  • Expected behavior: What you expected to happen.
  • Actual behavior: What actually happened, including any error messages or logs.
  • Environment details: Information like your operating system, VSCode version, and extension version.

Suggesting Features

Have a feature request or enhancement idea? Great! You can suggest new features by opening a feature request issue.

When suggesting a new feature, please include:

  • A clear description: Explain the feature in detail and why it would be beneficial.
  • Example or use cases: Provide specific examples or scenarios where this feature would improve the user experience.

Contributing Code

Step 1: Fork the repository

First, create a fork of this repository to your own GitHub account by clicking the "Fork" button at the top-right of this page.

Step 2: Clone your fork

Clone your fork locally using:

# Clone your fork locally
$ git clone https://github.com/your-username/git-master-plugin.git

# Go into the repository
$ cd git-master-plugin

Step 3: Create a new branch

Create a branch for your work:

# Create a new branch for your work
$ git checkout -b feature/my-new-feature

Step 4: Make your changes

Make your code changes, ensuring they align with the Code Standards.

Step 5: Commit your changes

After making changes, commit them with a clear and descriptive message:

# Commit your changes
$ git commit -m "Add feature: my new feature"

Step 6: Push your changes

Push the branch to your forked repository:

# Push to your forked repository
$ git push origin feature/my-new-feature

Step 7: Open a Pull Request

Go to the original repository and open a Pull Request (PR). Be sure to include a detailed description of your changes and link any relevant issues.

Code Standards

To ensure the project’s code remains consistent and maintainable, please follow these guidelines:

  • Use clear, readable code: Ensure that your code is easy to follow and documented where necessary.
  • Follow project structure: Keep code organized and consistent with the existing codebase.
  • Comment when necessary: If any part of your code might be unclear to others, include helpful comments.

Ensure your contributions don't introduce any breaking changes unless the modification is part of a planned update.

Pull Requests

Before submitting a pull request, make sure that:

  • Your code is well-tested and all tests pass.
  • Your changes adhere to the project's code style.
  • Any new functionality is appropriately documented.

Once your pull request is submitted, the maintainers will review it and provide feedback if necessary. Be prepared to make adjustments based on that feedback.

License

By contributing to this repository, you agree that your contributions will be licensed under the same license as the project—MIT License.