From aeeb93245628845c522b13f8a86ae1bb494e6729 Mon Sep 17 00:00:00 2001 From: Nathan Smith Date: Fri, 29 Mar 2024 20:37:19 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20docs:=20#46=20Add=20CONTRIBUTING?= =?UTF-8?q?.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Closes: #46 --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d868c67 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +# Pre-requisites + +Before making a pull request, please make an associated issue. New features should be discussed with project maintainers first. Bug fixes require no discussion. + +# Setup & Development + +1. Clone the repo somewhere outside of your obsidian vault directory +2. `npm install` (once) +3. `npm run dev` to run a watch process that will rebuild the plugin automatically when files change +4. After making changes, in another terminal window, `cp main.js styles.css manifest.json /path/to/your/vault/.obsidian/plugins/obsidian-github-link` +5. Reload obsidian + +# Code Standards + +Code must meet the following standards: + +- Conforms to the code style enforced by prettier +- Pass linting using the project's ESLint config (automated as a PR check) +- Pass a static code analysis scan by SonarCloud (automated as a PR check) +- Review by a project maintainer \ No newline at end of file