Skip to content
This repository was archived by the owner on Feb 8, 2024. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (21 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 1.1 KB

Contributing

Thank you for considering to contribute to npc-engine!

There are many ways you can contribute to npc-engine. Some examples would be creating issues with bug reports and feature requests, all kinds of pull requests, training custom deep learning models, spreading the word and using it in your future games.

Creating issues

Please start the issue title with one of the following tags:

  • [Feature request]
  • [Bug report]
  • [Question]
  • [Other]

Creating pull requests

Before creating any major pull requests (new APIs, model types, integrations) please create a [Feature request] issue so that we can discuss it. Here is the prefered workflow for creating pull requests:

  1. Fork the repository to your own Github account
  2. Clone the project to your machine
  3. Create a branch locally with a succinct but descriptive name
  4. Commit changes to the branch
  5. Make sure that tox passes
  6. Push changes to your fork
  7. Open a PR

Spreading the word

If you are using npc-engine in your game/app/program and you are OK to appear in "Made with npc-engine" list let us know at hello@npc-engine.com.