Skip to content
This repository was archived by the owner on Jun 5, 2025. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,3 +114,7 @@ When selecting the stack of view controllers, you will be prompted for the numbe
## Known issues and incompatibilities

Framework is compatible with iOS/tvOS 10 or above, but using it in iOS/tvOS 11 or higher for a better performance is strongly recommended.

## Contribute

In order to contribute to the ContainerCollection framework, first read our [Contribution guidelines](contribution_guidelines.md).
30 changes: 30 additions & 0 deletions contribution_guidelines.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Contribution guidelines

ContainerCollection is an open source library, we welcome contributors.

Before you send a PR, however, please make sure your change complies with these quick guidelines:

- Always unit test your code, PR won't be approved without it.
- Document APIs, in a way that makes new users of those APIs understand how they work, and highlight things that are good to keep in mind when using them.
- Follow our [style guide](README.md).
- For larger API change request, it's recommended to open an issue, where you can get quicker feedback on your idea instead of having to wait until it has been implemented or your PR gets approved.

## Code of conduct

The following code of conduct outline our expectation for contributors behaviour as well as the consequences for unacceptable behaviour. We require that all contributors abide by this Code.

### Expected behaviour

- We expect you accept full responsibility for your own work, you should review, correct, and testing your own work.
- We expect, reliable and quality contributions, all contributions not abeying this will be rejected.
- Give proper credit for intellectual property.
- Be honest and trustworthy. Also, if you found something wrong, we expect you to report it immediately to avoid undesirable consequences.
- Treat others with dignity and respect.

### Unacceptable behaviour

Unacceptable behaviour, including, harassing, abusive, discriminatory, derogatory or demeaning conduct will not be tolerated.

If you are subject to unacceptable behaviour, notice that someone else is being subject to unacceptable behaviour, or have any other concerns, please notify us as soon as possible.

We value your contributions and your dedication and effort and look forward to your contributions.