65 lines
1.7 KiB
Markdown
65 lines
1.7 KiB
Markdown
# Contributing to GodotDev.nvim
|
||
|
||
Thanks for your interest in contributing! 🎉
|
||
Please take a moment to read this guide to make the process smoother for everyone.
|
||
|
||
---
|
||
|
||
## 🛠 Prerequisites
|
||
|
||
Before contributing, make sure you have:
|
||
|
||
- **Godot**: version 4.x (check [Godot downloads](https://godotengine.org/download))
|
||
- **Neovim**: version 0.9 or later (check with `nvim --version`)
|
||
- A working **Terminal app** (e.g., Ghostty, Kitty, Alacritty, GNOME Terminal)
|
||
- **Git** installed and configured
|
||
|
||
---
|
||
|
||
## 🚀 Getting Started
|
||
|
||
1. **Fork** the repository and clone your fork locally:
|
||
```bash
|
||
git clone https://github.com/<your-username>/<your-plugin>.git
|
||
cd <your-plugin>
|
||
```
|
||
1. **Create** a branch for your work:
|
||
```bash
|
||
git checkout -b feature/my-new-feature
|
||
```
|
||
1. **Install** dependencies (if any).
|
||
Example:
|
||
```bash
|
||
# Neovim plugin manager setup (Lazy, Packer, etc.)
|
||
```
|
||
## 🧪 Testing your changes
|
||
|
||
- Run the plugin inside Neovim and test against Godot.
|
||
- Make sure you test with the versions you’ll list in your PR:
|
||
- Godot version
|
||
- Neovim version
|
||
- OS + Terminal
|
||
|
||
## 📖 Submitting a Pull Request
|
||
1. Ensure your code follows the style of the project.
|
||
1. Update documentation if needed.
|
||
1. Push your branch:
|
||
```bash
|
||
git push origin feature/my-new-feature
|
||
```
|
||
1. Open a **Pull Request**. The PR template will guide you.
|
||
|
||
## 🐛 Reporting Bugs
|
||
Please use the **Bug Report** issue template and include:
|
||
- Godot version
|
||
- Neovim version
|
||
- OS info
|
||
- Terminal app
|
||
- Steps to reproduce
|
||
|
||
## 💡 Suggesting Features
|
||
- Use the **Feature Request** template to describe:
|
||
- The problem you’re trying to solve
|
||
- Your proposed solution
|
||
- Alternatives you’ve considered
|