# Contributing

## Getting Started

Fork the repository to your own account.

Clone the repository to a suitable location on your local machine.

```bash
git clone https://gitlab.com/<%= gitlabName %>/<%= projectName %>.git
```

**Note:** This will clone the entire contents of the repository at the HEAD revision.

To update the project from within the project's folder you can run the following command:

```bash
git pull --rebase
```

### Building

Install the project's dependencies.

```bash
pip install -r requirements.txt
pip install -r requirements-dev.txt
```

### Testing

Install the project's dependencies.

```bash
```

Next, run the project's tests.

```bash
```

## Feature Requests

I'm always looking for suggestions to improve this project. If you have a suggestion for improving an existing feature, or would like to suggest a completely new feature, please file an issue with my [GitLab repository](https://gitlab.com/<%= gitlabName %>/<%= projectName %>/issues).

## Bug Reports

My project isn't always perfect, but I strive to always improve on that work. You may file bug reports on the [GitLab repository](https://gitlab.com/<%= gitlabName %>/<%= projectName %>/issues) site.

## Pull Requests

Along with my desire to hear your feedback and suggestions, I'm also interested in accepting direct assistance in the form of new code or documentation.

Please feel free to file merge requests against my [GitLab repository](https://gitlab.com/<%= gitlabName %>/<%= projectName %>/pulls).