docs: 📝 write contributing.md

Print-one · May 15, 2024 · b46c08b · b46c08b
1 parent 0a12e9b
commit b46c08b
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/.env.example b/.env.example
@@ -0,0 +1,2 @@
+API_URL=https://api.print.one
+API_KEY=live_abcdefghijklmnopqrstuvwxyz0123456789
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,23 @@
+# Contributing Guide
+
+## Setting up development environment
+
+### Prerequisites
+
+- Node.js
+- npm
+
+### Steps
+
+1. Clone the repository with `git clone https://github.com/Print-one/print-one-js.git`
+2. Enter the repository, and run `npm install` to install all dependencies.
+3. Run `npm run test` to run the tests. NOTE: This requires you to have followed the setting up test environment steps (see below).
+
+## Setting up test environment
+
+To setup the test environment, copy over the `.env.example` file to `.env` and fill in the required values.
+To then run the tests, run `npm run test`.
+
+## Pull Requests
+
+Make sure when submitting a pull requests that your code passes the tests, and that you have written tests for any new features or bug fixes.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		API_URL=https://api.print.one
		API_KEY=live_abcdefghijklmnopqrstuvwxyz0123456789