> For the complete documentation index, see [llms.txt](https://docs.netcap.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.netcap.io/develop-and-extend/contributing.md).

# Contributing

Contributing to the Netcap project

Contributions are welcome. If you have an idea or a question, open an issue or get in touch.

## Development Setup

Set up your development environment first:

* **macOS**: See the [macOS Development Setup](https://docs.netcap.io/develop-and-extend/macos-development-setup.md) guide, including the Protocol Buffer plugins.
* **Linux/Windows**: See the [Installation](https://docs.netcap.io/start-here/installation.md) guide and install the Protocol Buffers compiler and plugins.

## Issues & Bug Reports

Please include the Netcap version, the exact error messages and as much log output as you can.

A good bug report answers these questions:

* Which version of Netcap, which OS and which OS version did you use?
* What did you want to do?
* What happened instead?
* What output did you get?

## Contributor License Agreement (CLA)

All contributors must sign the Contributor License Agreement before their contributions can be accepted. This lets us keep offering NETCAP under both an open-source (GPLv3) and a commercial license.

### For Individual Contributors

When you open a pull request, the CLA Assistant bot checks whether you have signed the CLA. If you have not, it asks you to sign by commenting:

```
I have read and agree to the NETCAP Individual CLA Version 1.1
```

Read the full [Individual CLA](https://github.com/dreadl0ck/netcap/blob/master/.github/CLA-INDIVIDUAL.md) before signing.

### For Corporate/Entity Contributors

If you contribute on behalf of your employer or another organization, complete the [Entity CLA](https://github.com/dreadl0ck/netcap/blob/master/.github/CLA-ENTITY.md) and send it to the project maintainers before you submit contributions.

## Pull Requests

Before you open a pull request, make sure that:

1. The unit tests pass (`make test-unit`).
2. You have signed the CLA, or will sign it when the bot asks.

## Feature Requests

Have an idea for a new feature? Write a short feature draft and open an issue to discuss it.
