Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
93 lines (58 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

93 lines (58 loc) · 3.14 KB

Contributing to CodeScribe

Welcome to the CodeScribe project! We appreciate your interest in contributing to this Visual Studio Code extension. By contributing, you help make CodeScribe even better for developers.

Table of Contents

Getting Started

Before you start contributing, please make sure you have read and understood our Code of Conduct.

How to Contribute

There are several ways to contribute to CodeScribe, and we welcome all types of contributions, from reporting issues to submitting code changes.

1. Reporting Issues

If you encounter a bug, have a question, or want to request a new feature, you can create an issue in our issue tracker. When creating an issue, please provide as much detail as possible, including steps to reproduce, your operating system, and your Visual Studio Code version.

2. Suggesting Enhancements

If you have ideas for enhancing CodeScribe, feel free to create an enhancement proposal by opening an issue in our issue tracker. Describe the feature or improvement you have in mind, and we'll discuss it with you.

3. Code Contributions

We welcome code contributions! To contribute code changes:

  1. Fork this repository to your GitHub account.
  2. Create a new branch for your changes.
  3. Make your changes and commit them with clear and concise commit messages.
  4. Push your branch to your GitHub repository.
  5. Open a pull request (PR) in this repository with a clear description of your changes.
  6. Your PR will be reviewed by maintainers, and any necessary changes will be discussed.

Development Setup

To set up a development environment for CodeScribe, follow these steps:

  1. Clone your fork of the repository:

    git clone https://github.com/your-github-username/CodeScribe.git

  2. Navigate to the project directory:

    cd CodeScribe

  3. Install the project dependencies:

    npm install

  4. Build the extension:

    npm run compile

  5. Open the project in Visual Studio Code:

    code .

  6. Start debugging and developing your changes.

Code Style and Guidelines

Please follow the established coding style and guidelines used in the project. These guidelines help maintain consistency and make the codebase more accessible for everyone.

License

By contributing to CodeScribe, you agree that your contributions will be licensed under the project's MIT License. You retain the copyright to your contributions.

Thank you for contributing to CodeScribe!

By participating in this project, you agree to abide by the Code of Conduct.

If you have any questions or need assistance, please contact the project maintainers.