osa_tool recommendations

.github/BUG_ISSUE.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Is something not working as expected?
+title: "[Bug]: "
+labels: bug
+assignees: ''
+
+---
+
+Hi! Thank you for taking the time to report a bug with SAMPO_OSA_test.
+
+Additionally, please note that this platform is meant for bugs in SAMPO_OSA_test only.
+Issues regarding dependencies and libraries should be reported in their respective repositories.
+
+<!--- Provide a general summary of the issue in the Title above -->
+
+## Expected Behavior
+<!--- If you're suggesting a change/improvement, tell us how it should work -->
+
+## Current Behavior
+<!--- If suggesting a change/improvement, explain the difference from current behavior -->
+
+## Possible Solution
+<!--- Not obligatory, but suggest a fix/reason -->
+<!--- or ideas how to implement the addition or change -->
+
+## Steps to Reproduce
+<!--- Provide a link to a live example -->
+
+## Context [OPTIONAL]
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+<!--- Providing context helps us come up with a solution that is most useful in the real world -->

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,69 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

.github/CONTRIBUTING.md

@@ -0,0 +1,74 @@
+# Contributing to SAMPO_OSA_test
+
+We welcome you to [check the existing issues](https://github.com/ab211437/SAMPO_OSA_test/issues) for bugs or enhancements to work on.
+If you have an idea for an extension to SAMPO_OSA_test, please [file a new issue](https://github.com/ab211437/SAMPO_OSA_test/issues/new) so we can discuss it.
+
+Make sure to familiarize yourself with the project layout before making any major contributions.
+
+## How to contribute
+
+1. Fork the [project repository](https://github.com/ab211437/SAMPO_OSA_test/): click on the 'Fork' button near the top of the page. This creates a copy of the code under your account on the GitHub server.
+
+2. Clone this copy to your local disk:
+
+   ```bash
+   git clone [email protected]:YourUsername/SAMPO_OSA_test.git
+   ```
+
+3. Create a branch to hold your changes:
+
+   ```bash
+   git checkout -b my-contribution
+   ```
+
+4. Make sure your local environment is correctly set up for development and that all required project dependencies are installed.
+
+5. Start making changes on your newly created branch, remembering to
+   never work on the ``master`` branch! Work on this copy on your
+   computer using Git to do the version control.
+
+6. To check that your changes haven’t broken existing tests and that new tests pass, run the tests.
+
+7. When you're done editing and local testing, run:
+
+   ```bash
+   git add modified_files
+   git commit
+   ```
+
+   to record your changes in Git, then push them to GitHub with:
+
+   ```bash
+   git push -u origin my-contribution
+   ```
+
+Finally, go to the web page of your fork of the SAMPO_OSA_test repo, and click
+'Pull Request' (PR) to send your changes to the maintainers for review.
+
+When creating your PR, please make sure to enable the "Allow edits from maintainers" option (known as maintainer_can_modify).
+This allows the maintainers to make minor changes or improvements to your PR branch if necessary during the review process.
+
+(If it looks confusing to you, then look up the [Git
+documentation](http://git-scm.com/documentation) on the web.)
+
+## Before submitting your pull request
+
+Before you submit a pull request for your contribution, please work
+through this checklist to make sure that you have done everything
+necessary so we can efficiently review and accept your changes.
+
+If your contribution changes SAMPO_OSA_test in any way:
+
+- Update the [documentation](https://github.com/ab211437/SAMPO_OSA_test/tree/main/docs) so all of your changes are reflected there.
+
+- Update the [README](https://github.com/ab211437/SAMPO_OSA_test/tree/main/README.rst) if anything there has changed.
+
+If your contribution involves any code changes:
+
+- Update the [project tests](https://github.com/ab211437/SAMPO_OSA_test/tree/main/.github/workflows/test.yaml) to test your code changes.
+
+- Make sure that your code is properly commented with [docstrings](https://peps.python.org/pep-0257/) and comments explaining your rationale behind non-obvious coding practices.
+
+## Acknowledgements
+
+This document guide is based at well-written contributung guide of [TPOT](https://github.com/EpistasisLab/tpot) and [FEDOT](https://github.com/aimclub/FEDOT) frameworks.

.github/DOCUMENTATION_ISSUE.md

@@ -0,0 +1,21 @@
+---
+name: Documentation
+about: Found a typo or something that isn't crystal clear in our docs?
+title: "[Docs]: "
+labels: documentation
+assignees: ''
+
+---
+
+<!-- Thanks for taking the time to open an issue and help us make project better! -->
+
+## Motivation
+
+<!-- Why should we update our docs? -->
+
+
+
+## Suggestion
+
+<!-- What should we do instead? -->
+

.github/FEATURE_ISSUE.md

@@ -0,0 +1,68 @@
+---
+name: Feature request
+about: Want us to add any features to SAMPO_OSA_test?
+title: 'enh: '
+labels: enhancement
+assignees: ''
+
+---
+
+<!--
+  Hi! Thanks for considering to file a feature request with SAMPO_OSA_test. Please take the time to
+  answer the basic questions. Please try to be as detailed as possible.
+
+  Thanks!
+-->
+
+## Summary
+
+<!--
+  A one-paragraph explanation of the feature.
+-->
+
+## Motivation
+
+<!--
+  Why do you want to see this feature in SAMPO_OSA_test? What use cases does it support?
+-->
+
+## Guide-level explanation
+
+<!--
+  Explain the proposal as if it was already included in the project and you
+  were teaching it to another programmer. That generally means:
+
+  - Introducing new named concepts.
+  - Explaining the feature largely in terms of examples.
+  - If applicable, provide sample error messages, deprecation warnings, or
+    migration guidance.
+
+  If this is a small feature, you may omit this section.
+-->
+
+## Reference-level explanation
+
+<!--
+  This is the technical portion of the feature request. Explain the design in
+  sufficient detail that:
+
+  - Its interaction with other features is clear.
+  - It is reasonably clear how the feature would be implemented.
+  - Corner cases are dissected by example.
+
+  If you do not know how to answer this, you can omit it. No worries!
+-->
+
+## Drawbacks
+
+<!--
+  Why should we *not* do this?
+-->
+
+## Unresolved Questions
+
+<!--
+  What related issues do you consider out of scope for this feature that could be
+  addressed in the future independently of the solution that comes out of this
+  feature?
+-->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,53 @@
+<!--
+  Thanks for creating a Pull Request! Before you submit, please make sure
+  you've done the following:
+
+  - I read the contributing document at https://github.com/ab211437/SAMPO_OSA_test/tree/main/.github/CONTRIBUTING.md
+-->
+
+<!--
+  Help us quickly understand your PR! Choose one of the following by uncommenting it:
+-->
+
+<!-- This is a 🐛 Bug fix -->
+<!-- This is a ✨ New feature -->
+<!-- This is a 📝 Documentation update -->
+<!-- This is a 🔨 Code refactoring -->
+<!-- This is a 📦 Dependency update -->
+<!-- This is a ⚙️ Build/CI improvement -->
+
+---
+
+## Checklist
+
+Please check all that apply (`x` inside `[ ]`):
+
+- [ ] I've performed a self-review of my code
+- [ ] I've run linters and tests locally before submission
+- [ ] I've added tests (if it's a bug, feature or enhancement)
+- [ ] I've adjusted the documentation (if it's a feature or enhancement)
+
+## Summary
+
+<!--
+  Provide a description of what your pull request changes.
+-->
+
+## Context
+
+<!--
+  Is this related to any GitHub issue(s)?
+
+  You can use keywords to automatically close the related issue.
+  For example, (all of) the following will close issue #4567 when your PR is merged.
+
+  Closes #4567
+  Fixes #4567
+  Resolves #4567
+
+  Use any one of the above as applicable.
+-->
+
+## Additional Notes
+
+Add any additional context for reviewers (questions, implementation details, suggestions):

.github/workflows/osa_mkdocs.yml

@@ -0,0 +1,25 @@
+name: MkDocs workflow
+on:
+  push:
+    branches: ["main", "master"]
+  pull_request:
+    branches: ["main", "master"]
+jobs:
+  mkdocs_deployment:
+    name: "[OSA] Deploying MkDocs"
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: "[OSA] Checking-out repository"
+        uses: actions/checkout@v4
+      - name: "[OSA] Installing Python"
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+      - name: "[OSA] Installing MkDocs dependencies"
+        run: pip install mkdocs mkdocs-material mkdocstrings[python]
+      - name: "[OSA] MkDocs documentation deploying"
+        run: mkdocs gh-deploy --force --config-file osa_mkdocs.yml
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}