xref: /freebsd/contrib/libcbor/CONTRIBUTING.md (revision abd87254)
15d3e7166SEd Maste# Contributing to libcbor
25d3e7166SEd Maste
35d3e7166SEd Mastelibcbor is maintained by [@PJK](https://github.com/PJK) in his spare time on a best-effort basis.
45d3e7166SEd Maste
5*abd87254SEd MasteCommunity contributions are welcome as long as they align with the [project priorities](https://github.com/PJK/libcbor#main-features) and [goals](https://libcbor.readthedocs.io/en/latest/development.html#goals) and follow the guidelines described below.
65d3e7166SEd Maste
75d3e7166SEd Maste## Principles
85d3e7166SEd Maste
95d3e7166SEd Maste**Bug reports and questions:** Bug reports and specific technical questions are always welcome. Feel free to open an [issue](https://github.com/PJK/libcbor/issues).
105d3e7166SEd Maste
115d3e7166SEd Maste**Incremental improvements:** Bug fixes (including build scripts, examples, test, typos, CI/CD config, etc.) and documentation improvements (fixes of typos, inaccuracies, out of date content, etc.) are always welcome. Feel free to open a [PR](https://github.com/PJK/libcbor/pulls).
125d3e7166SEd Maste
135d3e7166SEd Maste**New features:** I am looking to keep the scope of libcbor small. If you would like to add a feature, please open an issue with your proposal (or reach out to me privately) to discuss if the feature fits into libcbor before opening a PR.
145d3e7166SEd Maste
155d3e7166SEd Maste**Major changes:** Please open an issue with your proposal (or reach out to me privately) to discuss if the improvement fits into cbor before opening a PR.
165d3e7166SEd Maste
175d3e7166SEd Maste## Pull Request Process
185d3e7166SEd Maste
195d3e7166SEd Maste1. Ensure that all CI checks pass
205d3e7166SEd Maste2. Check that the PR is complete and of good quality
215d3e7166SEd Maste    - Include a descriptive summary of the change. If the PR addresses an open issue, please link it.
225d3e7166SEd Maste    - Code changes: Add tests
235d3e7166SEd Maste    - If necessary: Update documentation, including any links
245d3e7166SEd Maste3. Code changes: Update [the changelog](https://github.com/PJK/libcbor/blob/master/CHANGELOG.md). Do *not* change the version number.
255d3e7166SEd Maste
265d3e7166SEd Maste## Interactions
275d3e7166SEd Maste
285d3e7166SEd MasteI work on libcbor on a best effort basis. The typical response time is a few days.
295d3e7166SEd Maste
305d3e7166SEd MasteIf you do not receive a response in a few weeks, feel free to ping the PR or issue.
315d3e7166SEd Maste
325d3e7166SEd Maste## Resources
335d3e7166SEd Maste
345d3e7166SEd Maste- [Development documentation](https://libcbor.readthedocs.io/en/latest/development.html)
355d3e7166SEd Maste
36