Merge pull request 'Add contributing' (#37) from add_contr into master
continuous-integration/drone/push Build is failing Details

Reviewed-on: #37
Reviewed-by: Inex Code <inex.code@selfprivacy.org>
pull/40/head^2
Inex Code 2023-06-12 15:43:12 +03:00
commit 8cc50ffa7d
2 changed files with 103 additions and 0 deletions

View File

@ -0,0 +1,52 @@
---
title: "How to contributing"
linkTitle: "Contributing"
date: 2023-03-13T
weight: 2
description: >
You can help with translations and programming
---
# How can you help the project?
## Help us translate
We use our own [weblate instance](https://weblate.selfprivacy.org/projects/selfprivacy/selfprivacy-app/) to collaborate.
You can create an account and help us translate the project into your native language.
## If you're a programmer
You can read about how SelfPrivacy works in [documentation](https://selfprivacy.org/docs/theory/).
You can help us close Issues which are marked with the "Contributions welcome" tag. For example, at [this link](https://git.selfprivacy.org/kherel/selfprivacy.org.app/issues?q=&type=all&state=open&labels=118) you will see tasks tagged "Contributions welcome" for the main application.
We cannot approve major changes without the approval of the core developers. Of course you can create a fork of the project, but if you want to get approval, please discuss the proposed changes in one of the project chats:
- [Telegram: @selfprivacy_dev](https://t.me/selfprivacy_dev)
- [Matrix: @dev:selfprivacy.org](https/matrix.to/#/%23dev:selfprivacy.org)
### [Python](https://www.python.org/) / [NixOS](https://nixos.org/) - backend
The server side of SelfPrivacy uses the NixOS distribution, and a daemon program written in Python called SelfPrivacy API. The daemon works to provide a link between your server and SelfPrivacy app. You can read [here](https://git.selfprivacy.org/SelfPrivacy/selfprivacy-rest-api/src/branch/master/CONTRIBUTING.md) about how to test and make changes to the SelfPrivacy API.
- [Backend Demon (SelfPrivacy API)](https://git.selfprivacy.org/SelfPrivacy/selfprivacy-rest-api)
You can also improve other components:
- [NixOS config](https://git.selfprivacy.org/SelfPrivacy/selfprivacy-nixos-config)
- [NixOS infect](https://git.selfprivacy.org/SelfPrivacy/selfprivacy-nixos-infect)
### [Dart](https://dart.dev/) + [Flatter](https://flutter.dev/) - frontend app
- [Repository](https://git.selfprivacy.org/kherel/selfprivacy.org.app)
### [Hugo](https://gohugo.io/) / [Docsy](https://docsy.dev/)
If you want to improve [our site](https://selfprivacy.org):
- [Main Site + Documentation](https://git.selfprivacy.org/SelfPrivacy/selfprivacy.org)
# For any help, please contact our chats:
- [Telegram: @selfprivacy_dev](https://t.me/selfprivacy_dev)
- [Matrix: @dev:selfprivacy.org](https/matrix.to/#/%23dev:selfprivacy.org)

View File

@ -0,0 +1,51 @@
---
title: "Как помочь проекту?"
linkTitle: "Как помочь проекту"
date: 2023-03-13T
weight: 2
description: >
Вы можете помочь как с переводом на разные языки, так и своими знаниями программирования
---
# Как вы можете помочь проекту?
## Помощь с переводом
Для колаборации мы используем наш собственный [инстанс weblate](https://weblate.selfprivacy.org/projects/selfprivacy/selfprivacy-app/).
Вы можете создать аккаунт и помочь нам перевести проект на ваш родной язык.
## Если вы программист
Про то, как работает SelfPrivacy, вы можете прочитать в [документации](https://selfprivacy.org/docs/theory/).
Вы можете помочь нам закрыть мелкие задачи в Issues, которые помечаны тегом "Contributions welcome". К примеру, по [ссылке](https://git.selfprivacy.org/kherel/selfprivacy.org.app/issues?q=&type=all&state=open&labels=118) вы увидите задачи с тегом "Contributions welcome" для основного приложения.
Мы не можем одобрить значительные изменения без согласования с основными разработчиками. Вы можете создать форк проекта, но если вы хотите получить одобрение, пожалуйста, обсудите предлагаемые изменения в одном из чатов проекта:
- [Telegram: @selfprivacy_dev](https://t.me/selfprivacy_dev)
- [Matrix: @dev:selfprivacy.org](https//matrix.to/#/%23dev:selfprivacy.org)
### [Python](https://www.python.org/) / [NixOS](https://nixos.org/) — backend
Серверная часть SelfPrivacy использует дистрибутив NixOS, и программу-демон написанную на Python, под названием SelfPrivacy API. Демон работает ради обеспечения связи между вашим сервером и приложением SelfPrivacy. Про то как тестировать и вносить изменения в SelfPrivacy API, вы можете прочитать [тут](https://git.selfprivacy.org/SelfPrivacy/selfprivacy-rest-api/src/branch/master/CONTRIBUTING.md).
- [Backend демон (SelfPrivacy API)](https://git.selfprivacy.org/SelfPrivacy/selfprivacy-rest-api)
Также вы можете улучшить другие наши NixOS компоненты:
- [NixOS config](https://git.selfprivacy.org/SelfPrivacy/selfprivacy-nixos-config)
- [NixOS infect](https://git.selfprivacy.org/SelfPrivacy/selfprivacy-nixos-infect)
### [Dart](https://dart.dev/) + [Flatter](https://flutter.dev/) — frontend app
- [Репозиторий](https://git.selfprivacy.org/kherel/selfprivacy.org.app)
### [Hugo](https://gohugo.io/) / [docsy](https://docsy.dev/)
Если вы знаете как улучшить [наш сайт](https://selfprivacy.org):
- [Главный сайт + Документация](https://git.selfprivacy.org/SelfPrivacy/selfprivacy.org)
# За любой помощью обращайтесь в наши чаты:
- [Telegram: @selfprivacy_dev](https://t.me/selfprivacy_dev)
- [Matrix: @dev:selfprivacy.org](https//matrix.to/#/%23dev:selfprivacy.org)