From 72332923fdc7aa8d8760be064d1ecad4d40b7d15 Mon Sep 17 00:00:00 2001
From: Nikolay Odegov <75427338+korhenon@users.noreply.github.com>
Date: Fri, 20 Mar 2026 15:20:01 +0300
Subject: [PATCH] osa_tool recommendations

---
 .github/CODE_OF_CONDUCT.md              | 69 +++++++++++++++++++++++
 .github/CONTRIBUTING.md                 | 74 +++++++++++++++++++++++++
 .github/DOCUMENTATION_ISSUE.md          | 21 +++++++
 .github/ISSUE_TEMPLATE/BUG_ISSUE.md     | 32 +++++++++++
 .github/ISSUE_TEMPLATE/FEATURE_ISSUE.md | 68 +++++++++++++++++++++++
 .github/PULL_REQUEST_TEMPLATE.md        | 53 ++++++++++++++++++
 .github/SECURITY.md                     | 22 ++------
 7 files changed, 323 insertions(+), 16 deletions(-)
 create mode 100644 .github/CODE_OF_CONDUCT.md
 create mode 100644 .github/CONTRIBUTING.md
 create mode 100644 .github/DOCUMENTATION_ISSUE.md
 create mode 100644 .github/ISSUE_TEMPLATE/BUG_ISSUE.md
 create mode 100644 .github/ISSUE_TEMPLATE/FEATURE_ISSUE.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md

diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
new file mode 100644
index 00000000..abecce4f
--- /dev/null
+++ b/.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
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 00000000..202f5adc
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,74 @@
+# Contributing to python-dotenv
+
+We welcome you to [check the existing issues](https://github.com/theskumar/python-dotenv/issues) for bugs or enhancements to work on.
+If you have an idea for an extension to python-dotenv, please [file a new issue](https://github.com/theskumar/python-dotenv/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/theskumar/python-dotenv/): 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 git@github.com:YourUsername/python-dotenv.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 python-dotenv 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 python-dotenv in any way:
+
+- Update the [documentation](https://saurabh-kumar.com/python-dotenv/) so all of your changes are reflected there.
+
+- Update the [README](https://github.com/theskumar/python-dotenv/tree/main/README.md) if anything there has changed.
+
+If your contribution involves any code changes:
+
+- Update the [project tests](https://github.com/theskumar/python-dotenv/tree/main/.github/workflows/test.yml) 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.
diff --git a/.github/DOCUMENTATION_ISSUE.md b/.github/DOCUMENTATION_ISSUE.md
new file mode 100644
index 00000000..e9afdc7e
--- /dev/null
+++ b/.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? -->
+
diff --git a/.github/ISSUE_TEMPLATE/BUG_ISSUE.md b/.github/ISSUE_TEMPLATE/BUG_ISSUE.md
new file mode 100644
index 00000000..acb5cf9e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/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 python-dotenv.
+
+Additionally, please note that this platform is meant for bugs in python-dotenv 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 -->
diff --git a/.github/ISSUE_TEMPLATE/FEATURE_ISSUE.md b/.github/ISSUE_TEMPLATE/FEATURE_ISSUE.md
new file mode 100644
index 00000000..fc1468e7
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/FEATURE_ISSUE.md
@@ -0,0 +1,68 @@
+---
+name: Feature request
+about: Want us to add any features to python-dotenv?
+title: 'enh: '
+labels: enhancement
+assignees: ''
+
+---
+
+<!--
+  Hi! Thanks for considering to file a feature request with python-dotenv. 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 python-dotenv? 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?
+-->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..ab3bead1
--- /dev/null
+++ b/.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/theskumar/python-dotenv/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):
diff --git a/.github/SECURITY.md b/.github/SECURITY.md
index 00d4d5e4..c06e935e 100644
--- a/.github/SECURITY.md
+++ b/.github/SECURITY.md
@@ -1,18 +1,8 @@
-# Security Policy
+ 
+# Reporting Security Issues
 
-## Supported Versions
+Our team take security bugs seriously. We appreciate your efforts to responsibly disclose your 
+findings, and will make every effort to acknowledge your contributions.
 
-| Version   | Supported          |
-| --------- | ------------------ |
-| latest    | :white_check_mark: |
-| 0.x       | :x:                |
-
-## Reporting a Vulnerability
-
-If you believe you have identified a security issue with python-dotenv, please email
-python-dotenv@saurabh-kumar.com. A maintainer will contact you acknowledging the report
-and how to continue.
-
-Be sure to include as much detail as necessary in your report. As with reporting normal
-issues, a minimal reproducible example will help the maintainers address the issue faster.
-If you are able, you may also include a fix for the issue generated with `git format-patch`.
+To report a security issue, please use the GitHub Security Advisory 
+["Report a Vulnerability"](https://github.com/theskumar/python-dotenv/security/advisories/new) tab.