Privacy-first password manager with built-in email aliasing. Fully encrypted and self-hostable.
Update CONTRIBUTING.md
Leendert de Borstcd5a01cafbe8
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex cc17a7a51..520cde680 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -11,7 +11,8 @@ Thanks for your interest in contributing to the AliasVault project! There are pl- [4.1 Pull requests](#41-pull-requests)- [4.2 Set up your local development environment](#42-set-up-your-local-development-environment)- [4.3 Supported versions](#43-supported-versions)-5. [License and Contributions](#5-license-and-contributions)+5. [AI tooling and accountability](#5-ai-tooling-and-accountability)+6. [License and Contributions](#6-license-and-contributions)---@@ -27,7 +28,7 @@ Help grow the AliasVault community by:## 2. Contributing to Translations-Help make AliasVault accessible to users worldwide by contributing translations! AliasVault is currently available in English and Dutch, but we're looking for volunteers to help translate it into other languages such as German, French, Spanish, Ukrainian, Italian, and more.+Help make AliasVault accessible to users worldwide by contributing translations! AliasVault is already available in 15+ languages, and we're always looking for volunteers to help add new languages and keep the existing translations complete and up to date.### UI Translations@@ -37,66 +38,92 @@ You can also get in contact via [Discord](https://discord.gg/DsaXMTEtpF) to chat### Identity Generator Translations-In AliasVault, when creating a new credential AliasVault automatically generates realistic alias identities including: first names, last names and birthdates. For this AliasVault uses dictionaries of possible names per language. You can help to enable AliasVault to generate proper identities in your language too.+When you create a new item, AliasVault automatically generates realistic alias identities including: first names, last names and birthdates. For this AliasVault uses dictionaries of possible names per language. You can help to enable AliasVault to generate proper identities in your language too.**How to help:**+- Create lists of common first names (male and female)- Create a list of common last names (surnames)- Optionally: Decade-specific names for more authentic generations-Read the specific instructions on how to contribute here: [Identity Generator Translations](https://docs.aliasvault.com/contributing/identity-generator.html).+Read the specific instructions on how to contribute here: [Identity Generator Translations](https://docs.aliasvault.com/contributing/identity-generator/).## 3. Contributing to the Documentation-The docs are built using Jekyll and automatically deploy to GitHub Pages via GitHub Actions. You can build the docs locally by running `docker compose up` in the `./docs` folder.--The docs site is based on the open-source template called Just The Docs. Find more information about how this template works in the [official docs](https://just-the-docs.github.io/just-the-docs/).+The docs are built using [Docusaurus](https://docusaurus.io/) and are automatically deployed via GitHub Actions. To run the docs locally with hot reload, run `npm ci && npm start` in the `./docs` folder; the site is then available at `http://localhost:5190`.To make changes to the AliasVault documentation please make a PR that directly edits the `docs` markdown files in this repository.## 4. Contributing to the Main Codebase-AliasVault is open to outside contributions in the form of ideas, feature requests but also pull requests. Please read the guidelines below.+AliasVault is open to outside contributions in the form of ideas, feature requests and pull requests. Please read the guidelines below.### 4.1 Pull requests-Pull requests generally fall into one of two categories:+Pull requests generally fall into one of the categories below:#### 4.1.1 Technical improvements-Bug fixes, refactors, performance improvements, tests and documentation fixes are more than welcome. Before starting work, please do make sure a GitHub issue exists for what you're planning so we can briefly discuss the merit. We may already have other ideas about how to approach it, or be working on it already internally. Follow the existing patterns established in the codebase, and make sure your changes pass the linting style checks and tests. This will give your PR the best chance of being reviewed and merged.-> For security related issues: please **do not** open a public PR or issue for a suspected vulnerability. Report it privately as described in [SECURITY.md](SECURITY.md) so it can be handled reponsibly.+Bug fixes, refactors, performance improvements, tests and documentation fixes are more than welcome. Before starting work, please do make sure a GitHub issue exists for what you're planning so we can discuss the proposed approach. We may already have other ideas about how to approach it, or be working on it already internally. Follow the existing patterns established in the codebase, and make sure your changes pass the linting style checks and tests. This will give your PR the best chance of being reviewed and merged.++> For security related issues: please **do not** open a public PR or issue for a suspected vulnerability. Report it privately as described in [SECURITY.md](SECURITY.md) so it can be handled responsibly.#### 4.1.2 Feature additions and UX changes-Anything that alters how AliasVault works and/or looks is something we handle carefully. Up front, please know that it's highly unlikely we'll accept pull requests for visual changes, new strings, new settings, or really anything that changes the user experience. Please talk to us first if you're planning something like this. There are cases where we may accept it, but in most situations we probably won’t.++Anything that alters how AliasVault works and/or looks is something we handle carefully. Up front, please know that it's highly unlikely we'll accept pull requests for visual changes, new strings, new settings, or really anything that changes the user experience. Please talk to us first if you're planning something like this. There are cases where we may accept it, but in most situations we probably won't.We care strongly about how AliasVault looks and behaves across all platforms (web app, browser extension, mobile), and getting this right is genuinely hard. That's why UI and UX changes are most likely to be done internally by the core maintainers, and why a no on your PR isn't meant personally.That said, we genuinely appreciate your ideas and proposals for UI/UX improvements. Please feel free to open a GitHub feature request issue (or reach out via [Discord](https://discord.gg/DsaXMTEtpF) or [email](mailto:[email protected])) describing the problem you're trying to solve, ideally with mockups where applicable. Or, if there's already an issue for it, add your thoughts in the comments.+#### 4.1.3 Cryptography++We don't accept pull requests from external contributors that change AliasVault's cryptographic design, such as algorithms, key derivation, the key hierarchy, encryption formats or authentication protocols. These changes are made by the core maintainers only.++Bug fixes in cryptographic code are welcome, but open an issue first so we can discuss the approach. If the bug could have security impact, do not open a public issue or PR: report it privately as described in [SECURITY.md](SECURITY.md).+### 4.2 Set up your local development environment-You can find instructions on how to get your local development environment setup for the different parts of the AliasVault codebase here:-https://docs.aliasvault.com/misc/dev/+You can find instructions on how to get your local development environment setup for the different parts of the AliasVault codebase here:-> Tip: if the URL above is not available, the raw doc pages can also be found in the `docs` folder in this repository.+[https://docs.aliasvault.com/contributing/development/](https://docs.aliasvault.com/contributing/development/)-If you run into any issues, feel free to join our [Discord](https://discord.gg/DsaXMTEtpF) to chat with the maintainers and author.+If you run into any issues, feel free to join our [Discord](https://discord.gg/DsaXMTEtpF) to chat with the maintainers.### 4.3 Supported versionsAt this time during the public beta, we only support the **latest major and minor** release. Currently we are on **0.x**, so in practice that means the **latest minor** only. We do not accept pull requests and/or backports that target older release lines.-## 5. License and Contributions+## 5. AI tooling and accountability++AliasVault is maintained by professional software engineers with extensive experience building secure software. The maintainers selectively use AI tools where doing so adds value, including for low-risk, repetitive tasks and as an additional layer of code review. They decide when these tools are appropriate based on the task, its risks and their own expertise. Maintainers are responsible for all engineering decisions: they personally review, understand and take responsibility for every change they merge into the project. AI assistance does not lower our standards for security, privacy or maintainability.++External contributors may use AI tools as well, in accordance with the rules below that apply to all contributions, both by maintainers and external contributors.++### 5.1 Authorship++Every contribution must be submitted by the person responsible for it. This responsibility includes understanding, verifying and explaining the work. We don't accept AI agents as independent contributors, or commits that list an AI tool as author or co-author.++### 5.2 Understanding and verification++Every contributor must:++- Understand every change they submit and how it interacts with the surrounding code, and be able to explain it in their own words.+- Personally review the complete diff, including generated code, tests, documentation and dependency changes.+- Test the change and describe what was verified, and what wasn't.+- Independently verify suggestions and findings from AI tools. An AI tool saying a change is correct or secure is not evidence of either.++## 6. License and ContributionsAliasVault is licensed under the GNU Affero General Public License v3.0 (AGPLv3). By submitting code, documentation, or other contributions to this project, you agree that:-1. Your contribution will be licensed under the same AGPLv3 license as the project-2. You have the legal right to grant this license (e.g., you are the author, or have permission)-3. You understand that your contribution will be made public under the AGPLv3 terms-4. You are not expected to provide support or warranties for your contribution-5. We do not accept commits generated or authored by LLMs or agents. Every commit must be personally authored, reviewed, tested, fully understood, and signed off by the contributor submitting it.+1. Your contribution will be licensed under the same AGPLv3 license as the project.+2. You have the legal right to grant this license (e.g., you are the author, or have permission).+3. You understand that your contribution will be made public under the AGPLv3 terms.+4. You are not expected to provide support or warranties for your contribution.+5. We do not accept contributions made solely by LLMs or agents. The person submitting a contribution must personally review, test, fully understand and take responsibility for it (see [AI tooling and accountability](#5-ai-tooling-and-accountability)).✅ There is no Contributor License Agreement (CLA) required. We believe in a balanced open source model where all contributors are treated equally under the terms of the AGPLv3.> By opening a pull request, you agree to these terms. Your contributions will be published under the AGPLv3 license.+