CONTRIBUTING.md

   1 # Contributing to libcbor
   2
   3 libcbor is maintained by [@PJK](https://github.com/PJK) in his spare time on a best-effort basis.
   4
   5 Community 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 belows.
   6
   7 ## Principles
   8
   9 **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).
  10
  11 **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).
  12
  13 **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.
  14
  15 **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.
  16
  17 ## Pull Request Process
  18
  19 1. Ensure that all CI checks pass
  20 2. Check that the PR is complete and of good quality
  21     - Include a descriptive summary of the change. If the PR addresses an open issue, please link it.
  22     - Code changes: Add tests
  23     - If necessary: Update documentation, including any links
  24 3. Code changes: Update [the changelog](https://github.com/PJK/libcbor/blob/master/CHANGELOG.md). Do *not* change the version number.
  25
  26 ## Interactions
  27
  28 I work on libcbor on a best effort basis. The typical response time is a few days.
  29
  30 If you do not receive a response in a few weeks, feel free to ping the PR or issue.
  31
  32 ## Resources
  33
  34 - [Development documentation](https://libcbor.readthedocs.io/en/latest/development.html)
  35