From a8a58c618ea48c405dd01706a1a746c3e025ee84 Mon Sep 17 00:00:00 2001 From: Michael Lynch Date: Sat, 22 Jun 2024 19:24:30 -0400 Subject: [PATCH 1/2] Document software requirements for developing htmx --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d6e3da44b..1e605cf7b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,6 +10,15 @@ Thank you for your interest in contributing! Because we're a small team, we have 1. If you haven't gotten any traction on an issue, feel free to bump it in the #issues-and-pull-requests channel on our Discord. 1. Want to contribute but don't know where to start? Look for issues with the "help wanted" tag. +## Creating a Development Environment + +To create a development environment for htmx, you'll need the following tools on your system: + +- Node.js 20.x or later +- Chrome or Chromium + +Additionally, the environment variable `CHROME_PATH` must contain the full path to the Chrome or Chromium binary on your system. + ## Pull Requests ### Technical Requirements 1. Code, including tests, must be written in ES5 for [IE 11 compatibility](https://stackoverflow.com/questions/39902809/support-for-es6-in-internet-explorer-11). From 8f72df48bbc23a6f5dbea2cb817b709504df5bba Mon Sep 17 00:00:00 2001 From: Michael Lynch Date: Sat, 22 Jun 2024 19:30:19 -0400 Subject: [PATCH 2/2] Expand explanations --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d6e3da44b..288b210dc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,6 +10,29 @@ Thank you for your interest in contributing! Because we're a small team, we have 1. If you haven't gotten any traction on an issue, feel free to bump it in the #issues-and-pull-requests channel on our Discord. 1. Want to contribute but don't know where to start? Look for issues with the "help wanted" tag. +## Creating a Development Environment +### Pre-requisites +To create a development environment for htmx, you'll need the following tools on your system: + +- Node.js 20.x or later +- Chrome or Chromium + +Additionally, the environment variable `CHROME_PATH` must contain the full path to the Chrome or Chromium binary on your system. + +### Installing Packages +To install htmx's required packages, run the following command: + +```bash +npm install +``` + +### Running Automated Tests +To verify that your htmx environment is working correctly, you can run htmx's automated tests with the following command: + +```bash +npm test +``` + ## Pull Requests ### Technical Requirements 1. Code, including tests, must be written in ES5 for [IE 11 compatibility](https://stackoverflow.com/questions/39902809/support-for-es6-in-internet-explorer-11).