Skip to content
Zeyu Zhao edited this page May 24, 2026 · 4 revisions

Contribution

Thanks for your interest in Password-Manager.

Before contributing code

Please read:

Password-Manager is security-sensitive software. Changes to cryptography, authentication, backup/recovery, frontend loading, CORS, or database format should be reviewed especially carefully.

Branches and releases

The master branch is the development branch.

Users should deploy stable releases from the GitHub Releases page. Documentation should make it clear whether it describes the latest stable release or development branch behavior.

Project layout

Current layout:

src/
  backend/
  frontend/
  initial.sql

Frontend code:

src/frontend/

Backend code:

src/backend/

Configuration files:

src/frontend/config.js
src/backend/function/config.php

Contribution rules

By contributing, you agree that your contribution can be published under the MIT license used by this project.

You can contribute by:

  • opening an issue
  • submitting a pull request
  • improving documentation
  • testing backup/recovery and upgrade paths
  • reviewing security-sensitive changes

Security-sensitive changes

For security-sensitive changes, please include:

  • what threat the change addresses
  • whether existing data remains readable
  • whether database migration is needed
  • whether old backups remain recoverable
  • whether config values or salts need migration
  • what manual upgrade steps are required

Documentation changes

When updating documentation, check that paths match the current split layout:

src/backend/function/config.php
src/frontend/config.js
src/frontend/password.html
src/frontend/recovery.html

Avoid reintroducing obsolete paths such as:

src/function/config.php
password.php
signup.php

Clone this wiki locally