# Contributing to Angular Highcharts Thank you for your interest in contributing to Angular Highcharts! This document provides guidelines and instructions for contributing to the project. ## Table of Contents - [Code of Conduct](#code-of-conduct) - [Getting Started](#getting-started) - [Development Workflow](#development-workflow) - [Commit Guidelines](#commit-guidelines) - [Pull Request Process](#pull-request-process) - [Coding Standards](#coding-standards) - [Testing](#testing) ## Code of Conduct By participating in this project, you are expected to uphold our Code of Conduct: - Be respectful and inclusive - Welcome newcomers and help them get started - Focus on what is best for the community - Show empathy towards other community members ## Getting Started ### Prerequisites - Node.js >= 18.19.0 - npm - Git ### Setting Up Your Development Environment 1. Fork the repository on GitHub 2. Clone your fork locally: ```bash git clone https://github.com/YOUR_USERNAME/angular-highcharts.git cd angular-highcharts ``` 3. Add the upstream repository: ```bash git remote add upstream https://github.com/cebor/angular-highcharts.git ``` 4. Install dependencies: ```bash npm install ``` 5. Set up the git commit message template (optional but recommended): ```bash git config commit.template .gitmessage ``` ## Development Workflow ### Project Structure This is an **Angular library wrapper** for Highcharts: - **Library code**: `projects/angular-highcharts/src/lib/` - the actual npm package - **Demo app**: `src/` - example application for testing the library ### Building the Library ```bash npm run build_lib ``` This builds the library to `dist/angular-highcharts` using Angular's `ng-packagr`. ### Running the Demo App ```bash npm start ``` The demo app serves as a testing ground for library changes. Access it at `http://localhost:4200`. ### Running Tests ```bash npm test ``` ### Making Changes 1. Create a new branch for your feature or fix: ```bash git checkout -b feat/my-new-feature # or git checkout -b fix/issue-description ``` 2. Make your changes in the `projects/angular-highcharts/src/lib/` directory for library code 3. Test your changes: - Build the library: `npm run build_lib` - Run the demo app: `npm start` - Run tests: `npm test` 4. Commit your changes following our [commit guidelines](#commit-guidelines) ## Commit Guidelines We follow the [Conventional Commits](https://www.conventionalcommits.org/) specification for commit messages. ### Commit Message Format ``` ():