Contributing - Dani-error/velar GitHub Wiki

Contributing to Velar

Contributions are welcome! If you wanna improve the library, fix bugs, or add new features โ€” here's how to get started.

Getting started

  1. fork this repo
  2. clone your fork locally: 
    git clone https://github.com/<your-username>/velar.git
cd velar
  3. create a new branch:
    • for features: feature/<your-feature-name>
    • for fixes: fix/<your-fix-name>
    git checkout -b fix/npc-optimization
  4. make your changes (in Kotlin). follow the existing code style.
  5. commit and push: 
    git add .
git commit -m "fix(optimization): npc action controller"
git push origin fix/npc-optimization
  6. open a pull request to main
    • describe what you changed and why
    • if itโ€™s a big feature, link a related issue (or open one first)

Contribution tips

  • keep PRs small and focused (easier to review and merge)
  • use clear commit messages (feat:, fix:, refactor: etc.)
  • test your changes on a local server before pushing
  • for discussions or questions, open an issue

Dev setup

Velar uses Kotlin and Gradle. Use any IDE that supports Kotlin (like IntelliJ IDEA)

License

Velar is MIT licensed, just as @juliarn/npc-lib. By contributing, you agree your code will be published under the same license.