Skip to content

Latest commit

 

History

History
43 lines (26 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

43 lines (26 loc) · 1.82 KB
Raw

Contributing

C2 is maintained by Teserakt AG and its team:

We welcome and encourage third-party contributions to C2, 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 c2.

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:

  • We use Go version >= 1.13 for developing C2.
  • Pull requests should target the develop branch.
  • Try to follow the established Go coding conventions.

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

./scripts/unittest.sh

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-)aggressive tone, and try to communicate clearly and succinctly. This is usually better for everyone :-)