Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: 📝 write contributing.md #16

Merged
merged 3 commits into from
May 16, 2024
+31 −0
Merged

docs: 📝 write contributing.md #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b46c08b
docs: :memo: write contributing.md
SophiaH67 May 15, 2024
c926a2a
docs: :memo: change example api key to a test key
SophiaH67 May 15, 2024
1080db0
docs: :memo: document the "next" branch
SophiaH67 May 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .env.example
View file
Open in desktop
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
View file
Open in desktop
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.
Loading