diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..7d43697 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @glevv diff --git a/CITATION.cff b/CITATION.cff index 45c46a1..bc6bd96 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -10,7 +10,6 @@ type: software authors: - given-names: Hleb family-names: Levitski - email: gleb.levitski@tutanota.com identifiers: - type: doi value: 10.5281/zenodo.10206933 @@ -19,4 +18,4 @@ repository-artifact: 'https://pypi.org/project/obscure_stats' abstract: Collection of lesser-known statistical measures license: MIT version: 0.2.0 -date-released: '2023-10-21' \ No newline at end of file +date-released: '2023-10-21' diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index b1510f9..19436db 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1 +1,3 @@ -This project adopts the Python Software Foundation Code of Conduct; [please read it here](https://www.python.org/psf/conduct/). \ No newline at end of file +# Code of Conduct + +This project adopts the Python Software Foundation Code of Conduct; [please read it here](https://www.python.org/psf/conduct/). diff --git a/README.md b/README.md index e3a2c6d..e49cc57 100644 --- a/README.md +++ b/README.md @@ -96,14 +96,18 @@ Robust measure of central tendency = 1.09±0.42 ## Code of Conduct -This project adopts the Python Software Foundation Code of Conduct; [please read it here](https://www.python.org/psf/conduct/). +Code of Conduct for this project can be found [here](CODE_OF_CONDUCT.md). ## Contributing -If you would like to contribute, you can read a short guide [here](https://github.com/glevv/obscure_stats/blob/main/CONTRIBUTING.md). +Contribution guidelines for this project can be found [here](CONTRIBUTING.md). + +## Security Policy + +Security Policy for this project can be found [here](SECURITY.md). ## License The content of this repository is licensed under a [MIT license](https://github.com/glevv/obscure_stats/blob/main/LICENSE.txt). -This repository bundles several libraries that are compatibly licensed. A full list can be found [here](https://github.com/glevv/obscure_stats/blob/main/LICENSES_bundled.txt). \ No newline at end of file +This repository bundles several libraries that are compatibly licensed. A full list can be found [here](https://github.com/glevv/obscure_stats/blob/main/LICENSES_bundled.txt). diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..6f90e8b --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,36 @@ +# Security Policy + +Thanks for helping make this repository safe for everyone! + +Authors of `obscure_stats` library take the security of the open source code repositories seriously and follow the security guidelines and services provided by GitHub. + +## Supported Versions + +| Version | Supported | +| ------- | ------------------ | +| 0.1.x | :x: | +| 0.2.x | :white_check_mark: | + +## Reporting a Vulnerability + +If you believe you have found a security vulnerability in this repository, please report it to author through coordinated disclosure. + +Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests. + +Instead, please send an email to securityobscurestats@skiff.com + +Please include as much of the information listed below as you can to help us better understand and resolve the issue: + +- The type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.); +- Full paths of source file(s) related to the manifestation of the issue; +- The location of the affected source code (tag/branch/commit or direct URL); +- Any special configuration required to reproduce the issue; +- Step-by-step instructions to reproduce the issue; +- Proof-of-concept or exploit code (if possible); +- Impact of the issue, including how an attacker might exploit the issue. + +This information will help triage your report more quickly. + +## Preferred Languages + +We prefer all communications to be in English. diff --git a/pyproject.toml b/pyproject.toml index 3a87497..e6c5d15 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -27,7 +27,6 @@ python = ">=3.9,<3.13" numpy = "^1.23.5" scipy = "^1.9.1" - [tool.poetry.group.dev.dependencies] mypy = "^1.6.1" pytest = "^7.4.3" @@ -84,4 +83,4 @@ skip-magic-trailing-comma = false line-ending = "auto" [tool.ruff.lint.pydocstyle] -convention = "numpy" \ No newline at end of file +convention = "numpy"