diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..695c457 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,37 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: '' +assignees: gcalin + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Replication information** + - OS: [e.g. Ubuntu 22.04, MacOS ...] + - Python version [e.g. 3.12, 3.13] +- Version information [e.g., commit hash, pip version] + - Output of pip freeze: + +``` +Paste output of `pip freeze` here +``` + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..dcf2bc2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[FEATURE]" +labels: '' +assignees: gcalin + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..ede15a9 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,44 @@ +# Contributor Code of Conduct + +As contributors and maintainers of this project, and in the interest of fostering an open +and welcoming community, we pledge to respect all people who contribute through reporting +issues, posting feature requests, updating documentation, submitting pull requests or +patches, and other activities. + +We are committed to making participation in this project a harassment-free experience for +everyone, regardless of level of experience, gender, gender identity and expression, +sexual orientation, disability, personal appearance, body size, race, ethnicity, age, +religion, or nationality. + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery +* Personal attacks +* Trolling or insulting/derogatory comments +* Public or private harassment +* Publishing other's private information, such as physical or electronic addresses, + without explicit permission +* Other unethical or unprofessional conduct + +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. + +By adopting this Code of Conduct, project maintainers commit themselves to fairly and +consistently applying these principles to every aspect of managing this project. Project +maintainers who do not follow or enforce the Code of Conduct may be permanently removed +from the project team. + +This Code of Conduct applies both within project spaces and in public spaces when an +individual is representing the project or its community. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by +contacting a project maintainer at `qcfd-EWI@tudelft.nl` . All complaints will +be reviewed and investigated and will result in a response that is deemed necessary and +appropriate to the circumstances. Maintainers are obligated to maintain confidentiality +with regard to the reporter of an incident. + +This Code of Conduct is adapted from the +[Contributor Covenant](https://contributor-covenant.org), version 1.3.0, available at +[contributor-covenant.org/version/1/3/0/](https://contributor-covenant.org/version/1/3/0/) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 979ea1d..af908b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing -Pull requests are welcome. To make a PR, first fork the repo, make your proposed changes on the main branch, and open a PR from your fork. If it passes tests and is accepted after review, it will be merged. For discussions about feature requests and contributions, please contact `c.a.georgescu@tudelft.nl`. +Pull requests are welcome. To make a PR, first fork the repo, make your proposed changes on the main branch, and open a PR from your fork. If it passes tests and is accepted after review, it will be merged. For discussions about feature requests and contributions, please contact `qcfd-EWI@tudelft.nl`. ## Code style diff --git a/README.md b/README.md index f6b98fd..f5ae311 100644 --- a/README.md +++ b/README.md @@ -125,4 +125,8 @@ doi = {https://doi.org/10.1016/j.cpc.2025.109699}, url = {https://www.sciencedirect.com/science/article/pii/S0010465525002012}, author = {C\u{{a}}lin A. Georgescu and Merel A. Schalkers and Matthias M\"{o}ller}, } -``` \ No newline at end of file +``` + +## Contact + +In addition to opening issues, you can contact the developers of `qlbm` at `qcfd-EWI@tudelft.nl`. \ No newline at end of file diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..0bd0775 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,14 @@ +# Security Policy + +## Supported Versions + +The following versions of ``qlbm`` are currently supported + +| Version | Supported | Python Requirement | Qiskit Requirement | +| ------- | ------------------ |------------------ |--------------------| +| 0.0.5 | :white_check_mark: | >=3.12 | >= 2.0.0 | +| <0.0.5 | :x: | >=3.8 | >= 1.0.0, <1.3 | + +## Reporting a Vulnerability + +To report a security vulnerability, you can contact `qcfd-EWI@tudelft.nl`. Please describe your vulnerability in detail, and include the exact version of Python, `qlbm`, and `qiskit` that are affected. diff --git a/pyproject.toml b/pyproject.toml index 9f8de33..9dc4819 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -38,7 +38,7 @@ dependencies = [ authors = [ { name = "qlbm authors" }, ] -maintainers = [{ name = "Calin Georgescu", email = "C.A.Georgescu@tudelft.nl" }] +maintainers = [{ name = "Calin Georgescu", email = "qcfd-EWI@tudelft.nl" }] description = "Quantum Algorithms for Lattice Boltzmann Methods." readme = "README.md"