From b46c08b8ad7657d069548eb5860b42d55e4e90d7 Mon Sep 17 00:00:00 2001 From: Sophia Hage Date: Wed, 15 May 2024 13:28:13 +0200 Subject: [PATCH 1/3] docs: :memo: write contributing.md --- .env.example | 2 ++ CONTRIBUTING.md | 23 +++++++++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 .env.example create mode 100644 CONTRIBUTING.md diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..db3d27e --- /dev/null +++ b/.env.example @@ -0,0 +1,2 @@ +API_URL=https://api.print.one +API_KEY=live_abcdefghijklmnopqrstuvwxyz0123456789 \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f37b42c --- /dev/null +++ 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. From c926a2af7341df33006b288471a7b4960fb17194 Mon Sep 17 00:00:00 2001 From: Sophia Hage Date: Wed, 15 May 2024 14:04:22 +0200 Subject: [PATCH 2/3] docs: :memo: change example api key to a test key --- .env.example | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.env.example b/.env.example index db3d27e..a177f50 100644 --- a/.env.example +++ b/.env.example @@ -1,2 +1,2 @@ API_URL=https://api.print.one -API_KEY=live_abcdefghijklmnopqrstuvwxyz0123456789 \ No newline at end of file +API_KEY=test_abcdefghijklmnopqrstuvwxyz0123456789 From 1080db038c9d1a7b5806cfe5ad25aaa12848390e Mon Sep 17 00:00:00 2001 From: Sophia Hage Date: Wed, 15 May 2024 14:07:45 +0200 Subject: [PATCH 3/3] docs: :memo: document the "next" branch --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f37b42c..aa33825 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,6 +18,12 @@ 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`. +## The "next" branch + +We have a branch called `next` that is used for features that are behind feature flags. All unreleased features / features still in development will be in this branch. If you want to contribute to a feature that is still in this state, make sure to branch off of `next` and submit a pull request to `next`. + +Next should also be kept in sync with `main` as much as possible, so that we can easily cherry-pick features into `main` when we are ready to release them. + ## 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.