Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (40 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

53 lines (40 loc) · 1.94 KB

Contributing to CodeDraft

First off, thank you for considering contributing to CodeDraft! It's people like you who make CodeDraft a great tool for everyone.

🚀 How to Contribute

  1. Fork the repository on GitHub.
  2. Clone your fork to your local machine.
  3. Create a new branch for your feature or bug fix.
  4. Make your changes and ensure they follow our coding standards.
  5. Commit your changes with descriptive commit messages.
  6. Push your changes to your fork.
  7. Submit a Pull Request (PR) to the main branch of the original repository.

💻 Development Setup

To set up the development environment, follow these steps:

  1. Install Node.js (v18 or higher).
  2. Install VS Code.
  3. Install dependencies: 
    npm install
  4. Compile the extension: 
    npm run compile
  5. Open the project in VS Code and press F5 to open a "Extension Development Host" window with the extension loaded.

📝 Coding Standards

  • We use TypeScript for all extension logic.
  • Follow the existing code style and patterns.
  • Ensure all new features are documented in the README.md and include relevant context in learning captures.
  • Keep the user interface minimal and consistent with VS Code's design guidelines.

🐞 Reporting Issues

If you find a bug or have a feature request, please open an issue on GitHub. Be sure to provide:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • Details about your environment (OS, VS Code version, CodeDraft version).
  • Expected vs. actual behavior.

✅ Pull Request Process

  • Ensure your code builds without errors (npm run compile).
  • Update documentation if you've added or changed features.
  • Provide a clear description of the changes in your PR.
  • Wait for a maintainer to review and merge your PR.

Thank you for contributing!