mirror/aliasvault
1
0
Fork 0
mirror of https://github.com/aliasvault/aliasvault.git synced 2026-04-04 23:05:19 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Leendert de Borst
2025-06-24 11:18:27 +02:00
committed by GitHub
parent 76c60ad200
commit 006f89b6b7
1 changed files with 50 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
CONTRIBUTING.md
View File

@@ -1,26 +1,60 @@
# Contributing to the source code
We welcome contributions to AliasVault. Please read the guidelines on the official AliasVault docs website on how to get your local development environment setup and the general contribution guidelines:
# Contributing to AliasVault
Thanks for your interest in contributing to the AliasVault project! There are a lot of ways to help out.
## Community Engagement
Become active in AliasVault's community, helping by:
- **Answering questions** in our [Discord community](https://discord.gg/DsaXMTEtpF)
- **Helping users** with self-hosting setup and troubleshooting
- **Reporting bugs** and suggesting improvements
- **Participating in discussions** about features and improvements
## Spreading the Word
Getting the word out about AliasVault is important so we can reach and help more people to improve their privacy. You can help by:
- **Sharing on social media** (X, Reddit, Mastodon, etc.)
- **Writing blog posts** about your AliasVault experience
- **Creating video tutorials** or walkthroughs
- **Mentioning AliasVault** in privacy/self-hosting discussions
- **Telling friends and colleagues** about the project
## 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/).
To make changes to the AliasVault documentation please make a PR that directly edits the `docs` markdown files in this repository.
## Contributing to the Main Codebase
### Get in contact
If you’re planning to work on a new feature or improvement for AliasVault, we strongly encourage you to get in touch with us first. This ensures that your proposed changes align with the project's direction and increases the likelihood of your work being accepted into the official repository. You can reach us through:
- Opening an issue on GitHub to discuss your proposed changes
- Reaching out via Discord or email
- Contacting the maintainers directly
### 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.net/misc/dev/
> Tip: if the URL above is not available, the raw doc pages can also be found in the `docs` folder in this repository.
## 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.
If you run into any issues, feel free to join our [Discord](https://discord.gg/DsaXMTEtpF) to chat with the maintainers and author.
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/).
## License and Contributions
AliasVault 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:
To make changes to the AliasVault documentation please make a PR that directly edits the `docs` markdown files in this repository.
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
## Contributor License Agreement (CLA)
Thank you for your interest in contributing to AliasVault (“Project”).
✅ 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 submitting code, documentation, or other contributions to this Project, you agree to the following:
1. You are legally entitled to grant this license (e.g., you are the author, or have permission).
2. You grant the Project maintainers a perpetual, worldwide, non-exclusive, royalty-free license to use, modify, distribute, and sublicense your contribution as part of the Project and any derivative works.
3. You understand that your contribution will be made public and licensed under the same terms as the Project (e.g., AGPLv3), or any later version the maintainers may release.
4. You are not expected to provide support or warranties for your contribution.
> All contributors must accept the CLA as a condition of contributing. By opening a pull request, you agree to these terms. We may enforce this automatically via GitHub if needed.
> By opening a pull request, you agree to these terms. Your contributions will be published under the AGPLv3 license.