From 0085055492831e4849968724bacb0db16a142ab4 Mon Sep 17 00:00:00 2001 From: Ihor Makhnyk <146889658+ingvarus-bc@users.noreply.github.com> Date: Mon, 13 Nov 2023 13:05:04 +0200 Subject: [PATCH 1/2] Update README with contribution guidelines --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index ea54597c..72366496 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,7 @@ This repository contains Swift community-maintained implementation over [OpenAI] - [Utilities](#utilities) - [Combine Extensions](#combine-extensions) - [Example Project](#example-project) +- [Contribution Guidelines](#contribution-guidelines) - [Links](#links) - [License](#license) @@ -953,6 +954,37 @@ You can find example iOS application in [Demo](/Demo) folder. ![mockuuups-iphone-13-pro-mockup-perspective-right](https://user-images.githubusercontent.com/1411778/231449395-2ad6bab6-c21f-43dc-8977-f45f505b609d.png) +## Contribution Guidelines +Make your Pull Requests clear and obvious to anyone viewing them. +Set `main` as your target branch. + +#### Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) principles in naming PRs and branches: + +- `Feat: ...` for new features and new functionality implementations. +- `Bug: ...` for bug fixes. +- `Fix: ...` for minor issues fixing, like typos or inaccuracies in code. +- `Chore: ...` for boring stuff like code polishing, refactoring, deprecation fixing etc. + +PR naming example: `Feat: Add Threads API handling` or `Bug: Fix message result duplication` + +Branch naming example: `feat/add-threads-API-handling` or `bug/fix-message-result-duplication` + +#### Write description to pull requests in following format: +- What + + ... +- Why + + ... +- Affected Areas + + ... +- More Info + + ... + +We'll appreciate you including tests to your code if it is needed and possible. ❤️ + ## Links - [OpenAI Documentation](https://platform.openai.com/docs/introduction) From d7fb335b4e9b04334c78df33510e87e5a27c22a5 Mon Sep 17 00:00:00 2001 From: Ihor Makhnyk <146889658+ingvarus-bc@users.noreply.github.com> Date: Tue, 14 Nov 2023 02:42:15 +0200 Subject: [PATCH 2/2] Create CONTRIBUTING.md --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..9679d7a6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +## Contribution Guidelines +Make your Pull Requests clear and obvious to anyone viewing them. +Set `main` as your target branch. + +#### Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) principles in naming PRs and branches: + +- `Feat: ...` for new features and new functionality implementations. +- `Bug: ...` for bug fixes. +- `Fix: ...` for minor issues fixing, like typos or inaccuracies in code. +- `Chore: ...` for boring stuff like code polishing, refactoring, deprecation fixing etc. + +PR naming example: `Feat: Add Threads API handling` or `Bug: Fix message result duplication` + +Branch naming example: `feat/add-threads-API-handling` or `bug/fix-message-result-duplication` + +#### Write description to pull requests in following format: +- What + + ... +- Why + + ... +- Affected Areas + + ... +- More Info + + ... + +We'll appreciate you including tests to your code if it is needed and possible. ❤️