Skip to content

Latest commit

 

History

History
68 lines (51 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

68 lines (51 loc) · 2.76 KB
Raw

Contributing

libe4 is maintained by Teserakt AG and its team:

We welcome and encourage third-party contributions to libe4, be it reports of issues encountered while using the software, suggestions of new features, or proposals of patches.

Bug reports

Bugs, problems, and feature requests should be reported on GitHub Issues.

If you report a bug, please:

  • Check that it's not already reported in the GitHub Issues.
  • Provide information to help us diagnose and ideally reproduce the bug.

We appreciate feature requests, however we cannot guarantee that all the features requested will be added to e4go.

Patches

We encourage you to fix a bug or implement a new feature via a GitHub Pull request, preferably after creating a related issue and referring it in the PR.

If you contribute code and submit a patch, please note the following design philosophy of the code, which must be adhered to. Unfortunately, we cannot accept patches that deviate from these rules:

  • The code must run freestanding. Certain parts of libc may not be available or may not be appropriate for certain functionality. If in doubt, we will be happy to discuss and clarify.
  • C89 is targeted for maximum portability. Testing code may be compiled with later versions of C for convenience.
  • Any kind of dynamic allocation is prohibited. This includes the use of malloc, calloc, and some more surprising functions such as strdup. Some security and safety testing profiles in (for example) the automotive industry require this. In addition, an allocator may not be available in target environment.
  • Host unit tests may deviate from the above rules (see C89) but should generally avoid using the library in ways that it would not be used in production (i.e. malloc is still prohibited).
  • Device tests (tests designed to be deployed on devices) may vary.
  • Pull requests should target the develop branch.
  • Please follow the C coding conventions that exist.

Also please make sure to create new unit tests covering your code additions. You can execute the tests by running:

CONF=yourmode make test

All third-party contributions will be recognized in the list of contributors.

House rules

When posting on discussion threads, please be respectful and civil, avoid (passive-)agressive tone, and try to communicate clearly and succinctly. This is usually better for everyone :-)