docs: added CONTRIBUTING.md

CONTRIBUTING.md

@@ -0,0 +1,95 @@
+# Contributing to PyOutlineAPI
+
+Thank you for considering contributing to PyOutlineAPI! Whether you have suggestions, bug reports, or code improvements,
+your input is valuable. Here are some guidelines to help you contribute effectively:
+
+## How to Contribute
+
+### Reporting Issues
+
+If you encounter any issues or bugs, please follow these steps:
+
+1. **Search for Existing Issues**: Check the [Issues](https://github.com/orenlab/pyoutlineapi/issues) section to see
+   if your issue has already been reported.
+2. **Create a New Issue**: If you don't find an existing
+   issue, [open a new issue](https://github.com/orenlab/pyoutlineapi/issues/new) with a clear description of the
+   problem. Include:
+    - A descriptive title
+    - Steps to reproduce the issue
+    - Expected and actual results
+    - Any relevant code snippets or logs
+
+### Suggesting Enhancements
+
+If you have an idea for a new feature or improvement:
+
+1. **Check Existing Feature Requests**: Look through the [Issues](https://github.com/orenlab/pyoutlineapi/issues) to
+   see if a similar feature has already been suggested.
+2. **Open a New Feature Request**: [Submit a new feature request](https://github.com/orenlab/pyoutlineapi/issues/new)
+   with:
+    - A descriptive title
+    - A detailed description of the proposed feature
+    - Use cases and benefits
+    - Any related documentation or examples
+
+### Contributing Code
+
+To contribute code:
+
+1. **Fork the Repository**: Create a fork of the repository on GitHub.
+2. **Clone Your Fork**: Clone your fork locally.
+   ```bash
+   git clone https://github.com/orenlab/pyoutlineapi.git
+   ```
+3. **Create a New Branch**: Create a new branch for your changes.
+   ```bash
+   git checkout -b my-feature-branch
+   ```
+4. **Make Your Changes**: Implement your changes, ensuring to follow existing code styles and conventions.
+5. **Write Tests**: Add or update tests to cover your changes.
+6. **Run Tests**: Ensure all tests pass before submitting a pull request.
+7. **Commit and Push**: Commit your changes and push them to your fork.
+   ```bash
+   git add .
+   git commit -m "Add new feature or fix bug"
+   git push origin my-feature-branch
+   ```
+8. **Submit a Pull Request**: Open a pull request from your branch to the `main` branch of the original repository.
+   Provide a clear description of your changes and any relevant details.
+
+## Code of Conduct
+
+Please adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) in all interactions. Respectful and constructive
+communication is essential for a positive and productive community.
+
+## Style Guide
+
+Follow these guidelines to ensure consistency in the codebase:
+
+- **Code Style**: Adhere to [PEP 8](https://pep8.org/) for Python code style.
+- **Documentation**: Update documentation as needed to reflect code changes. Use clear, concise language and proper
+  formatting.
+- **Commit Messages**: Write clear and descriptive commit messages. Use the following format:
+  ```
+  [type]: [short summary]
+
+  [longer description, if necessary]
+  ```
+
+  Types of commits might include:
+    - `feat`: A new feature
+    - `fix`: A bug fix
+    - `docs`: Documentation changes
+    - `style`: Code style improvements (non-functional changes)
+    - `refactor`: Code refactoring (no functional changes)
+    - `test`: Adding or updating tests
+    - `chore`: Other changes (e.g., build process, CI configuration)
+
+## Contact
+
+For any questions or additional information, feel free to reach out:
+
+- **Email**: pytelemonbot@mail.ru
+- **GitHub Issues**: [Link](https://github.com/orenlab/pyoutlineapi/issues)
+
+Thank you for contributing to PyOutlineAPI!