From 89a393d4792887317d327b25f65f23cad69675a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=9C=D0=B8=D1=85=D0=B0=D0=B8=D0=BB?= Date: Thu, 29 Aug 2024 10:25:37 +0300 Subject: [PATCH] Add more info to contribution guide (#17) --- CONTRIBUTING.md | 18 +++++++++++++++++- {test => tests}/demo/README.md | 0 {test => tests}/demo/demo.ml | 0 {test => tests}/demo/dune | 0 {test => tests}/sid/dune | 0 {test => tests}/sid/test_sid.ml | 0 6 files changed, 17 insertions(+), 1 deletion(-) rename {test => tests}/demo/README.md (100%) rename {test => tests}/demo/demo.ml (100%) rename {test => tests}/demo/dune (100%) rename {test => tests}/sid/dune (100%) rename {test => tests}/sid/test_sid.ml (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 489b319..d702112 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,6 +10,22 @@ FEEL FREE TO CREATE ISSUES AND PRs - Dune - OPAM +```sh +# Create a switch for project +$ opam switch create . --deps-only +# Or just install deps +$ opam install . --deps-only +``` + ### How to start? -See [development demo](./tests/dev/). \ No newline at end of file +See [development demo](./tests/demo/). + +### Tasks + +You can find open tasks at [project board](https://github.com/users/romanchechyotkin/projects/1) +and [issues page](https://github.com/romanchechyotkin/nats.ocaml/issues). + +### Questions + +If you have any questions, please contact @romanchechyotkin or @dx3mod. diff --git a/test/demo/README.md b/tests/demo/README.md similarity index 100% rename from test/demo/README.md rename to tests/demo/README.md diff --git a/test/demo/demo.ml b/tests/demo/demo.ml similarity index 100% rename from test/demo/demo.ml rename to tests/demo/demo.ml diff --git a/test/demo/dune b/tests/demo/dune similarity index 100% rename from test/demo/dune rename to tests/demo/dune diff --git a/test/sid/dune b/tests/sid/dune similarity index 100% rename from test/sid/dune rename to tests/sid/dune diff --git a/test/sid/test_sid.ml b/tests/sid/test_sid.ml similarity index 100% rename from test/sid/test_sid.ml rename to tests/sid/test_sid.ml