Skip to content

Latest commit

 

History

History
67 lines (56 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

67 lines (56 loc) · 2.19 KB

Contributing to Svelte Radar

Thank you for your interest in contributing to Svelte Radar! Your contributions help improve the project and enhance the SvelteKit development experience.

Getting Started

Prerequisites

Before contributing, ensure you have the following installed:

  • Node.js (LTS version recommended)
  • npm (comes with Node.js)
  • Visual Studio Code (for development and testing)

Setting Up the Project

  1. Fork the Repository: Click the Fork button on GitHub.
  2. Clone Your Fork: 
    git clone https://github.com/YOUR-USERNAME/svelte-radar.git
cd svelte-radar
  3. Install Dependencies: 
    npm install
  4. Run the Extension in VS Code:
    • Open the project in VS Code.
    • Press F5 to launch a new VS Code window with the extension loaded.

Contributing Guidelines

Reporting Issues

If you find a bug or have a feature request:

  • Check the existing issues to avoid duplicates.
  • If the issue doesn’t exist, create a new issue with a clear description and, if possible, steps to reproduce.

Submitting Changes

  1. Create a new branch for your changes: 
    git checkout -b feature/your-feature-name
  2. Make and test your changes in VS Code.
  3. Commit your changes with a descriptive message: 
    git commit -m "Add: Short description of change"
  4. Push your branch to your fork: 
    git push origin feature/your-feature-name
  5. Open a Pull Request (PR) on GitHub:
    • Provide a clear title and description.
    • Reference any related issues.
    • Ensure all checks pass before requesting a review.

Code Style

  • Follow the existing code structure and naming conventions.
  • Ensure your changes do not break existing functionality.
  • Keep PRs focused and small.

Code of Conduct

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

Need Help?

If you have any questions, feel free to:

  • Open an issue.
  • Start a discussion in the repository.

Thank you for contributing! 🚀