-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #16 from oleg-nenashev/slack
Add Slack links and stability badges
- Loading branch information
Showing
2 changed files
with
26 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters