​
Getting Started

NyxVim is an open-source project, and we welcome contributions from the community. Whether you’re fixing bugs, adding new features, or improving documentation, your help is appreciated.

Before you start contributing, please make sure you’ve read our Code of Conduct.

​
Types of Contributions

We welcome various types of contributions, including:

  • Bug fixes
  • New features
  • Documentation improvements
  • Performance enhancements
  • UI/UX improvements

If you’re unsure about a contribution, feel free to open an issue to discuss it first!

​
Making a Pull Request

When submitting a pull request (PR), please follow these guidelines:

  1. Be Descriptive: Provide a clear and detailed description of your changes.
  2. Stay Focused: Keep your PR focused on a single issue or feature.
  3. Follow Coding Standards: Ensure your code adheres to our coding standards.
  4. Test Your Changes: Make sure your changes don’t break existing functionality.

NyxVim aims to be less bloated. PRs for existing plugin enhancements, new features using existing plugins, bug fixes, and corrections are more encouraged than adding new plugins.

​
Code Style

We use StyLua for code formatting. Please ensure your code is formatted according to our StyLua configuration:

column_width = 120
line_endings = "Unix"
indent_type = "Spaces"
indent_width = 2
quote_style = "AutoPreferDouble"
call_parentheses = "None"
collapse_simple_statement = "Always"

Run StyLua on your code before submitting a PR to ensure consistent formatting.

​
Other Ways to Contribute

Contributing isn’t just about code. Here are other ways you can help:

  1. Help Other Users: Assist other NyxVim users on GitHub discussions, issues, or our Discord server.
  2. Improve Documentation: Help us improve our documentation by fixing errors or adding examples.
  3. Spread the Word: Star our GitHub repo and share NyxVim with others.
  4. Provide Feedback: Use NyxVim and provide constructive feedback on how we can improve.

​
Financial Contributions

If you’d like to support NyxVim financially:

Support NyxVim

Consider making a donation to support the development of NyxVim.

​
Best Practices

  1. Communicate: If you’re working on something, let others know by commenting on the issue or creating a new one.
  2. Be Patient: Review processes take time. We appreciate your contribution and will get to it as soon as possible.
  3. Be Open to Feedback: Be prepared to make changes to your PR based on review comments.
  4. Keep it Simple: Start with small, manageable contributions and work your way up.

​
Need Help?

If you’re having trouble with any NyxVim features or have questions:

  • Check our FAQ section for common questions and answers.
  • Join our Discord community to chat with other NyxVim users.
  • Participate in GitHub Discussions to engage with the NyxVim community, share ideas, and get help.
  • For bug reports or feature requests, open an issue on our GitHub repository.

Thank you 🤍 for considering contributing to NyxVim. Your efforts help make NyxVim better for everyone!