diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b6c4950..8214698 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,29 @@ # Contributing +[![Slack: testcontainers-c on slacktestcontainers.org](https://img.shields.io/badge/Slack-%23testcontainers%E2%80%94c-brightgreen?style=flat&logo=slack)](http://slack.testcontainers.org/) +[![Stability: Experimental](https://masterminds.github.io/stability/experimental.svg)](https://masterminds.github.io/stability/experimental.html) + Contributions are welcome! -To propose a code patch, just submit a pull request to the repository. For any feedback and suggestions, use GitHub Issues. +## Community Slack + +We use the `#testcontainers-c` channel on [Testcontainers Slack](http://slack.testcontainers.org/). +Please join this channel if you want to discuss contributions/strategy/whatever. +GitHub Issues are recommended for most of the proposals and bug reports though. + +## Code patches + +To propose a code patch, just submit a pull request to the repository. +No need to create a GitHub issue if you want to suggest a simple patch, +pull requests are more than enough for it. + ## Codestyle ### Public APIs -- Snake Case is used to name methods +- `snake_case` is used to name methods - `tc_` is used as a prefix for all exported Testcontainers functions +- When possible, we try to avoid special Golang types in public API and try to expose wrapper types +- `const` is important for users, and please add it to your arguments when possible. + There is no Const in Golang, so some `typedef` injection is needed when importing CGo diff --git a/README.md b/README.md index 8d388c8..efc9ba6 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,16 @@

+[![Slack: testcontainers-c on slacktestcontainers.org](https://img.shields.io/badge/Slack-%23testcontainers%E2%80%94c-brightgreen?style=flat&logo=slack)](http://slack.testcontainers.org/) +[![Stability: Experimental](https://masterminds.github.io/stability/experimental.svg)](https://masterminds.github.io/stability/experimental.html) +[![GitHub release (latest by date)](https://img.shields.io/github/v/release/oleg-nenashev/testcontainers-c)](https://github.com/oleg-nenashev/testcontainers-c/releases) + > **WARNING**: This is a prototype. > There is a lot to do before it can be distributed and used in production, > see the GitHub Issues. > The plan is to provide vcpkg and Conan packages, now it is an importable CMake project. > A feasible level of feature parity with Testcontainers Go is needed too, > hence a lot of wrapper coding. -> Contributions are welcome! This is not a standalone [Testcontainers](https://testcontainers.org/) engine, but a C-style shared library adapter for native languages like C/C++, D, Lua, Swift, etc. @@ -20,6 +23,9 @@ It is a MVP SDK that can be later extended for the languages. The project is based on [Testcontainers for Go](https://golang.testcontainers.org/) which is one of the most powerful Testcontainers implementations. +Contributions and feedback are welcome! +Also join the `#testcontainers-c` channel on the [Testcontainers Slack](http://slack.testcontainers.org/). + ## Key Features - Minimum viable Testcontainers API functionality: