diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..58794d7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,64 @@ +# 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//.git + cd + ``` +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