How to Contribute

Pax25 is open source and is happy to take contributions from the community! If you're planning to make a contribution, please read this document first, and then head over to the development setup instructions.

License

Pax25 is licensed under the AGPLv3 license. This means that any contributions you make will be licensed under the same terms. A copy of this license is at the root of the repository.

Creating Issues

If there's a major feature you'd like to add, please create an issue on the GitLab issue tracker, and describe the feature in detail, and how you think it should be implemented. This will allow us to assist you in creating a pull request that will be accepted.

If it's a minor enhancement or bug fix, just go ahead and create a merge request. If you're not sure if it's a minor enhancement or bug fix, create an issue, and we'll help you out.

If you've found a bug but aren't sure how to fix it, create an issue and describe it in as much detail as possible. We'll try to help you out.

Documentation improvements are also welcome-- details on how to build the documentation are in the development setup instructions.

Dependencies

It is the policy of this pax25 that external dependencies are to be absolutely minimized for client developer installation. This is due to the expectation that this library will be used primarily by ham radio operators, and not be fast-moving commercial entities. Accordingly, we expect that projects using this library may not be keeping up to date with bleeding-edge changes, and have opted to minimize the surface area of code rot.

However, more flexibility is afforded to building and testing. If there's a package that will assist in development or documentation, that's more likely to be accepted as a dependency.