# Contributing to Zep

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

The following is a set of guidelines for contributing to Zep.  These are mostly guidelines, not rules.
Use your best judgment, and feel free to propose changes to this document in a pull request.

#### Table Of Contents

[Code of Conduct](#code-of-conduct)

## Code of Conduct

This project and everyone participating in it is governed by the [Zep Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to cmaughan.

## How Can I Contribute?

Either report an issue or send a pull request!  

Instructions for building are on the main page.  Make sure you at least build the demo and play with it, and run the unit tests - instructions on the main page also.
The CI, on the 'Actions' tab builds on all 3 platforms, along with running unit tests.  If you are stuck on build issues, consult the scripts in the .github/workflows folder to see how the application is built.

In your pull request, add the following comment:
`@all-contributors please add @your-user-name for code`
This will add you to the list of the contributors on the readme page, once your PR is accepted.  You can also use 'docs', 'tests', etc. depending on your contribution.