From f814c857eb9e191138cd7bb7e713e584f059276d Mon Sep 17 00:00:00 2001 From: Christian Aranda Date: Wed, 18 Sep 2019 16:10:31 +0200 Subject: [PATCH 1/3] added contribution guidelines --- README.md | 4 ++++ contribution_guidelines.md | 13 +++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 contribution_guidelines.md diff --git a/README.md b/README.md index 8d8f964..f230fe8 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/contribution_guidelines.md b/contribution_guidelines.md new file mode 100644 index 0000000..46d51d4 --- /dev/null +++ b/contribution_guidelines.md @@ -0,0 +1,13 @@ +# 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 +This project adheres to the [Open Code of Conduct](https://github.com/todogroup/opencodeofconduct). By participating, you are expected to honor this code. From 506aa409f9192ed8c44b9261cd3dc76abfaac7b1 Mon Sep 17 00:00:00 2001 From: Christian Aranda Date: Fri, 27 Sep 2019 12:16:28 +0200 Subject: [PATCH 2/3] Added our own code of conduct --- contribution_guidelines.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/contribution_guidelines.md b/contribution_guidelines.md index 46d51d4..49006bc 100644 --- a/contribution_guidelines.md +++ b/contribution_guidelines.md @@ -10,4 +10,21 @@ Before you send a PR, however, please make sure your change complies with these - 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 -This project adheres to the [Open Code of Conduct](https://github.com/todogroup/opencodeofconduct). By participating, you are expected to honor this code. + +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. From ed90e62a28f1db2c8ad8539a77261d360f15d9b9 Mon Sep 17 00:00:00 2001 From: Christian Aranda Date: Fri, 27 Sep 2019 12:17:18 +0200 Subject: [PATCH 3/3] Missing ending dot. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f230fe8..a86ac1e 100644 --- a/README.md +++ b/README.md @@ -117,4 +117,4 @@ Framework is compatible with iOS/tvOS 10 or above, but using it in iOS/tvOS 11 o ## Contribute -In order to contribute to the ContainerCollection framework, first read our [Contribution guidelines](contribution_guidelines.md) +In order to contribute to the ContainerCollection framework, first read our [Contribution guidelines](contribution_guidelines.md).