Merge pull request #118 from MacPaw/chore/add-contribution-guidelines…

…-to-readme

Update README with contribution guidelines

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. ❤️

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)