From 6c2bbea3c8d5d0ec33140b20b0e679721ad2e291 Mon Sep 17 00:00:00 2001
From: bscan <10503608+bscan@users.noreply.github.com>
Date: Thu, 16 Jun 2022 21:04:38 -0400
Subject: Adding Contributing.md

---
 CONTRIBUTING.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 CONTRIBUTING.md

(limited to 'CONTRIBUTING.md')

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..7851093
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,16 @@
+
+# How to Contribute
+
+Thanks for the interest in contributing. I highly encourage people to contribute to this project if they're interested.
+If you want to discuss any features, feel free to file an issue or find me on discord or Reddit. 
+In general, I welcome issues and pull requests. I may not get to all the issues as this is a personal project, but they're good to track.
+
+## Beginner issues
+
+Check out the issue tracker. Issues tagged "Good First Issue" should be relatively straightfoward. The issues tagged "Help Wanted" are typically slightly trickier and require more specialized knowledge of either Perl or Typescript and would be a huge help. Feel free to reach out if any ticket interests you.
+
+
+## Architecture
+The Perl Navigator is roughly half in typescript and half in Perl. To run only the Perl side itself, check the Perl Navigator logs in VSCode. It will show the example command for testing a file. 
+The key command will look something like `perl -c -I /home/brian/.vscode-server/extensions/bscan.perlnavigator-0.3.0/server/src/perl -MInquisitor /tmp/msg_test.pl`
+If you run this command by itself, you can see how the typescript side and the perl side interface with each other. The output of this command will include all the diagnostics in addition to a set of tags relevant to the file under consideration. 
-- 
cgit v1.2.3