# Developing Thank you for your interest in contributing to hashbrown. ## Prerequisites - [Node Version Manager (nvm)](https://github.com/nvm-sh/nvm) installed on your machine. ## Setup 1. **Install the required Node.js version:** Use nvm to install and use the correct Node.js version for the project. ```sh nvm install nvm use ``` 2. **Create the environment configuration:** Copy `.env.example` to `.env` and replace placeholder values with your actual API Keys. For example: ``` OPENAI_API_KEY=your-key-here ``` You may need separate keys depending on which AI providers you plan to test. 3. **Install dependencies:** Navigate to the project root directory and install the necessary dependencies. ```sh npm install ``` ## Running the project 1. **Start the backend server:** Edit `samples/smart-home/server/src/main.ts` to enable the appropriate AI provider by commenting/uncommenting the relevant lines. Run the following command to start the backend server: ```sh npx nx serve server ``` 2. **Start the frontend application:** Run the following command to start the Angular sample application: ```sh npx nx serve client ``` Run the following command to start the React sample application: ```sh npx nx serve client-react ``` ## Optional Dev Container Open the project in VSCode / Cursor and install the Dev Container extension. Then, open the command palette and select `Reopen in Container`. This will start the development environment inside a container. ## Running Tests To run the full test suite locally: ```sh npx nx run-many --target=test --all ``` ## Submitting Pull Requests **Please follow these steps to simplify PR reviews — maintainers will request changes if these aren’t followed.** - Please rebase your branch against the current main. - Make sure your development dependencies are up-to-date. - Please ensure the test suite passes before submitting a PR. - If you've added new functionality, **please** include tests which validate its behavior. - Make reference to possible [issues](https://github.com/liveloveapp/hashbrown/issues) on PR comment. ## Submitting bug reports - Please search through issues to see if a previous issue has already been reported and/or fixed. - When possible, provide a _small_ reproduction using a StackBlitz project or a GitHub repository. - Detail the affected browser(s) and operating system(s). ## Submitting new features - We value the brevity of our API surface. This is taken into consideration when building new features. - Submit an issue with the prefix `RFC:` with your feature request. - The feature will be discussed and considered. - Once the PR is submitted, it will be reviewed and merged upon approval. ## Questions and requests for support Questions and requests for support should not be opened as issues and should be handled in the following ways: - The team behind hashbrown provides [enterprise support](https://hashbrown.dev/enterprise). We'd love to learn more about your project and how we can add value to your team. - Start a new [Q&A discussion](https://github.com/liveloveapp/hashbrown/discussions/categories/q-a) on GitHub. ## Commit Message Guidelines We have very precise rules over how our git commit messages can be formatted. This leads to **more readable messages** that are easy to follow when looking through the **project history**. But also, we use the git commit messages to **generate the the changelog**. ### Commit Message Format Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**: ``` ():