Skip to content

docs: refresh contributor docs and add SECURITY, RELEASING and CHANGELOG - #525

Merged
philomath213 merged 2 commits into
mainfrom
docs/contributor-and-release
Sep 5, 2026
Merged

docs: refresh contributor docs and add SECURITY, RELEASING and CHANGELOG#525
philomath213 merged 2 commits into
mainfrom
docs/contributor-and-release

Conversation

@philomath213

Copy link
Copy Markdown
Member

Brings CONTRIBUTING in line with the current toolchain and adds the three project docs that were missing.

  • CONTRIBUTING: ruff + pre-commit instead of black/flake8, uv and the PEP 735 dev group, correct test commands, and no submodule step. Marks the Bazel test targets as broken. Fixes two dead links — the OpenMined/Roadmap repository no longer exists
  • SECURITY.md (new): what belongs here versus in SEAL, reporting via GitHub issues, and threat-model notes
  • RELEASING.md (new): TestPyPI rehearsal → tag → GitHub Release, and why each step exists
  • CHANGELOG.md (new): seeded at 0.3.17, earlier releases point to the releases page

Issue templates, the PR template and the Code of Conduct are inherited from OpenMined/.github, so none are added here.

@philomath213
philomath213 requested a review from youben11 August 4, 2026 09:24
@philomath213 philomath213 added the Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase label Aug 22, 2026
Comment thread CONTRIBUTING.md Outdated
Comment on lines +55 to +60
Planned work is tracked in [GitHub issues](https://github.com/OpenMined/TenSEAL/issues).
Direction is set mainly by the homomorphic encryption group at OpenMined; the
[Slack community](https://slack.openmined.org) is the place to discuss it.

> **Note:** the `OpenMined/Roadmap` repository this section used to link to no
> longer exists.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no team that is currently managing the project. I think it's important to make it clear that there is no serious support to TenSEAL right now

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. I have replaced the section with a plain "Project status" that says the project isn't actively maintained and that issues and PRs may go unanswered.

@philomath213
philomath213 force-pushed the docs/contributor-and-release branch from 1fd5e4d to 5a838bd Compare September 5, 2026 12:22
@philomath213
philomath213 merged commit e5ca5e2 into main Sep 5, 2026
14 checks passed
@philomath213
philomath213 deleted the docs/contributor-and-release branch September 5, 2026 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants