From 5879a4a6a55bf78a89d710f56cc934d913c1de43 Mon Sep 17 00:00:00 2001 From: QueenOfSquiggles <8940604+QueenOfSquiggles@users.noreply.github.com> Date: Tue, 20 Aug 2024 10:43:49 -0500 Subject: [PATCH] Added basic contribution guidelines --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 400f786..7e897ad 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,19 @@ Hierarchical Task Networks are characterized by having a concrete set of specifi ## Guaranteed Best Documentation The best documentation will always be the examples and unit tests. The example `basic_htnp` should be an excellent way to show how to get started. + +## Contibuting + +(I definitely need better contribution guidlines someday...) + +#### What I am doing to make this crate better +- Integrating into my own game(s) +- Fixing issues I come across wrt my games +- Adding features necessary to my games that are general enough to be applicable to other games + +#### What you can do to make this crate better +- Report bugs (see issue templates) +- Create feature request write-ups (see issue templates) +- Submit PRs **for existing feature requests** + +Overall, your contributions must not affect the licensing of this crate. 99% of the time this shouldn't be a problem. As long as you write your own code, your contributions should be fine.