# Contributing to @ng-idle This guide will describe how _you_ can contribute to this module. - [Getting Help](#getting-help) - [Reporting Issues](#issues) - [Submitting an issue](#submitting) - [Git Commit Guidelines](#committing) - [Submitting a Pull Request](#pr) ## Getting Help Questions and comments for Angular should be directed [here][angularhelp]. I ask that you do not use GitHub Issues to ask questions. Instead, please use [Gitter] or [StackOverflow] for help. ## Reporting Issues If you find a bug in the source code, an issue with an implementation, or a mistake in the documentation, you can help by submitting an issue in [GitHub Issues][githubissues] for this [repository][github]. ### Submitting an Issue Please search through [existing issues][githubissues] and the archive first to see if your question was already answered or if the issue you are experiencing has already been reported. Once you have determined that you have an unreported problem, please use the following guidelines when opening an issue. - Overview of the Issue - Include any non-minified stack trace and other runtime errors that are available and relevant to the issue. - Use Case - Explain why this is a bug for you - Angular and `@ng-idle` version(s) - Is this an issue with Angular, or a regression bug in this module? - Reproduce the Error - Please, please, please **provide a working example** either by including a Plunker or JSFiddle, or an unambiguous set of steps! Doing the footwork up front will allow us to replicate and fix the problem faster. - Related Issues - Please note any related issues, if any. - Suggest a Fix - If you have an idea of what's causing the problem (line of code or a commit), please point it out. ## Git Commit Guidelines We follow the `conventional-changelog` format used by the Angular team. You can follow the format manually, but we highly recommend you use a CLI wizard such as [Commitizen][commitizen]. In fact, We have configured this repository to work with Commitizen. First, ensure Commitizen CLI is installed via `npm install -g commitizen`. Next, make sure the clone of this repository is installed via `npm install`. You're all set! Now, whenever you want to commit, just stage your changes e.g. `git add .` and commit using `git cz`. Follow the prompts and you're done. ### Commit Message Format Each commit message should consist of up to three lines: **header**, **body**, and **footer**. Additionally, the **header** should be a special format containing the **type**, **scope**, and **subject**. ``` ():