Contributing to ideaDrop.nvim

Thank you for your interest in contributing to ideaDrop.nvim! This document provides guidelines and instructions for contributing to this project.

🎯 Development Setup

Fork the repository

Clone your fork:

git clone https://github.com/YOUR_USERNAME/ideaDrop.nvim.git
cd ideaDrop.nvim

Create a new branch for your feature/fix:

git checkout -b feature/your-feature-name

📝 Code Style

Follow the Lua Style Guide
Use TypeScript-style type annotations in comments
Keep functions small and focused
Write meaningful commit messages following Conventional Commits

Example of type annotations:

---@param config table Configuration table
---@field idea_dir string Directory to store ideas
---@return nil
local function setup(config)
  -- function implementation
end

🧪 Testing

Test your changes in a clean Neovim environment
Ensure all commands work as expected
Test edge cases and error handling
Update documentation if necessary

📚 Documentation

Update doc/ideaDrop.txt for any new commands or features
Add examples for new functionality
Keep the README.md up to date
Document any breaking changes

🔄 Pull Request Process

Update the README.md and documentation with details of changes
Update the version number in any relevant files
The PR must pass all checks
Get a review from at least one maintainer
Once approved, your PR will be merged

🐛 Bug Reports

When reporting bugs, please include:

Neovim version
Operating system
Steps to reproduce
Expected behavior
Actual behavior
Relevant error messages
Your configuration

✨ Feature Requests

When suggesting features:

Describe the feature in detail
Explain why it would be useful
Provide examples of how it would work
Consider potential edge cases

📋 Code of Conduct

Be respectful and inclusive
Be patient and welcoming
Be thoughtful
Be collaborative
When disagreeing, try to understand why

🎉 Your First Contribution

Look for issues labeled good first issue
Comment on the issue to let us know you're working on it
Follow the development setup steps above
Submit your PR

📄 License

By contributing to ideaDrop.nvim, you agree that your contributions will be licensed under the project's MIT License.

Thank you for contributing to ideaDrop.nvim! 🚀

2.5 KiB Raw Blame History