Skip to content

Commit

Permalink
Merge pull request #16 from Print-one/docs/contributing
Browse files Browse the repository at this point in the history
docs: 📝 write contributing.md
  • Loading branch information
SophiaH67 authored May 16, 2024
2 parents 0a12e9b + 1080db0 commit b6a7033
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
API_URL=https://api.print.one
API_KEY=test_abcdefghijklmnopqrstuvwxyz0123456789
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# 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`.

## 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.

0 comments on commit b6a7033

Please sign in to comment.