Add a contribution guide

Author: sovrasov

CONTRIBUTING.md

@@ -0,0 +1,107 @@
+# Contributing to Model API
+
+We welcome your input! 👐
+
+We want to make it as simple and straightforward as possible to contribute to this project, whether it is a:
+
+- Bug Report
+- Discussion
+- Feature Request
+- Creating a Pull Request (PR)
+- Becoming a maintainer
+
+## Bug Report
+
+We use GitHub issues to track the bugs. Report a bug by using [Issues](https://github.com/open-edge-platform/model_api/issues/new) page.
+
+## Feature Request
+
+We utilize GitHub issues to track the feature requests as well. If you are certain regarding the feature you are interested and have a solid proposal, you could then create the feature request by [Issues](https://github.com/open-edge-platform/model_api/issues/new) page.
+
+## Development & PRs
+
+We actively welcome your pull requests:
+
+### Getting Started
+
+#### 1. Fork and Clone the Repository
+
+First, fork the Model API repository by following the GitHub documentation on [forking a repo](https://docs.github.com/en/enterprise-cloud@latest/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo). Then, clone your forked repository to your local machine and create a new branch from `master`.
+
+#### 2. Set Up Your Development Environment
+
+Set up your development environment to start contributing. This involves installing the required dependencies and setting up pre-commit hooks for code quality checks. Note that this guide assumes you are using [Venv](https://docs.python.org/3/library/venv.html) for python environments management. However, the steps are similar for other env managers.
+
+<details>
+<summary>Development Environment Setup Instructions</summary>
+
+1. Create and activate a new python environment:
+
+   ```bash
+   python -m venv .mapi
+   source .mapi/bin/activate
+   ```
+
+2. Install the development requirements:
+
+   ```bash
+   pip install -e ./src/python[full]
+   ```
+
+3. [Build](https://github.com/open-edge-platform/model_api?tab=readme-ov-file#c) C++ binaries
+
+Make sure to address any pre-commit issues before finalizing your pull request.
+Pre-commit checks can be launched by the command:
+
+```bash
+pre-commit run --all-files
+```
+
+</details>
+
+### Making Changes
+
+1. **Write Code:** Follow the project's coding standards and write your code with clear intent. Ensure your code is well-documented and includes examples where appropriate. For code quality we use ruff, whose configuration is in [`pyproject.toml`](pyproject.toml) file.
+
+2. **Add Tests:** If your code includes new functionality, add corresponding tests using [pytest](https://docs.pytest.org/en/7.4.x/) to maintain coverage and reliability.
+
+3. **Update Documentation:** If you've changed APIs or added new features, update the documentation accordingly. Ensure your docstrings are clear and follow [Google's docstring guide](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings).
+
+4. **Pass Tests and Quality Checks:** Ensure the test suite passes and that your code meets quality standards by running:
+
+   ```bash
+   pre-commit run --all-files
+   python tests/cpp/precommit/prepare_data.py -d data -p tests/cpp/precommit/public_scope.json
+   python tests/python/accuracy/prepare_data.py -d data
+   pytest tests/python/
+
+   build/test_sanity -d data -p tests/cpp/precommit/public_scope.json && build/test_model_config -d data
+   build/test_accuracy -d data -p tests/python/accuracy/public_scope.json
+   ```
+
+5. **Update the Changelog:** For significant changes, add a summary to the [CHANGELOG](CHANGELOG.md).
+
+6. **Check Licensing:** Ensure you own the code or have rights to use it, adhering to appropriate licensing.
+
+7. **Sign Your Commits:** Use signed commits to certify that you have the right to submit the code under the project's license:
+
+   ```bash
+   git commit -S -m "Your detailed commit message"
+   ```
+
+   For more on signing commits, see [GitHub's guide on signing commits](https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification/signing-commits).
+
+### Submitting Pull Requests
+
+Once you've followed the above steps and are satisfied with your changes:
+
+1. Push your changes to your forked repository.
+2. Go to the original Model API repository you forked and click "New pull request".
+3. Choose your fork and the branch with your changes to open a pull request.
+4. Fill in the pull request template with the necessary details about your changes.
+
+We look forward to your contributions!
+
+## License
+
+You accept that your contributions will be licensed under the [Apache-2.0 License](https://choosealicense.com/licenses/apache-2.0/) if you contribute to this repository. If this is a concern, please notify the maintainers.