Move to monorepo
Move all of our code into a monorepo in preparation of open sourcing our server.
First I describe the general plan, then later I've kept an exact log of the
commands that I used. This was all done prior to this commit, but this commit
(that introduces the various top level files) seems like a good way to summarize
the entire process.
Clone auth. Auth is our base repository.
```sh
git clone https://github.com/ente-io/auth.git && cd auth
```
Move all of auth's files into `auth/`.
```sh
mkdir auth
git mv `find . -maxdepth 1 | grep -v -e '\.$' -e '\.\/.git$' -e '\.\/auth$'` auth
git commit -m 'Move into auth/'
```
Add photos-web as a new remote, and fetch its main.
```sh
git remote add photos-web https://github.com/ente-io/photos-web.git
git fetch photos-web main
```
Switch to main of web-photos.
```sh
git checkout -b photos-web-main photos-web/main
```
Move all of its files into `web` (note, the find now has an extra exclusion for
`web`, but we keep all the old ones too):
```sh
mkdir web
git mv `find . -maxdepth 1 | grep -v -e '^\.$' -e '^\.\/.git$' -e '^\.\/auth$' -e '^\.\/web$'` web
git commit -m 'Move into web/'
```
Switch back to main main, and merge the photos-web branch. The
`--allow-unrelated-histories` flag is needed (since these two branches don't
have any previous common ancestor).
```sh
git checkout main
git merge --allow-unrelated-histories photos-web-main
```
That's it. We then repeat this process for all the other repositories that we
need to bring in.
There is no magic involved here, so regular git commands will continue working.
However, all the files get renamed, so to track the git history prior to this
rename commit we'll need to pass the `--follow` flag.
git log --follow -p -- auth/migration-guides/encrypted_export.md
For some file names like README.md which exist in multiple repositories, this
doesn't seem to work so good (I don't fully understand why). For example,
`git log --follow -p -- auth/README.md lists the changes to all the READMEs,
not just the auth README.md.
```sh
git clone https://github.com/ente-io/auth.git ente
cd ente
mkdir auth
git mv `find . -maxdepth 1 | grep -v -e '\.$' -e '\.\/.git$' -e '\.\/auth$'` auth
git commit -m 'Move into auth/'
git remote add photos-web https://github.com/ente-io/photos-web.git
git fetch photos-web main
git checkout -b photos-web-main photos-web/main
mkdir web
git mv `find . -maxdepth 1 | grep -v -e '^\.$' -e '^\.\/.git$' -e '^\.\/auth$' -e '^\.\/web$'` web
git commit -m 'Move into web/'
git checkout main
git merge --allow-unrelated-histories photos-web-main
git branch -D photos-web-main
git remote remove photos-web
git remote add photos-app https://github.com/ente-io/photos-app.git
git fetch photos-app main
git checkout -b photos-app-main photos-app/main
mkdir mobile
git mv `find . -maxdepth 1 | grep -v -e '^\.$' -e '^\.\/.git$' -e '^\.\/auth$' -e '^\.\/web$' -e '^\.\/mobile$'` mobile
git commit -m 'Move into mobile/'
git checkout main
git merge --allow-unrelated-histories photos-app-main
git branch -D photos-app-main
git remote remove photos-app
git remote add photos-desktop https://github.com/ente-io/photos-desktop.git
git fetch photos-desktop main
git checkout -b photos-desktop-main photos-desktop/main
mkdir desktop
git mv `find . -maxdepth 1 | grep -v -e '^\.$' -e '^\.\/.git$' -e '^\./.gitmodules$' -e '^\.\/desktop$'` desktop
git mv .gitmodules desktop
git commit -m 'Move into desktop/'
git checkout main
git merge --allow-unrelated-histories photos-desktop-main
git branch -D photos-desktop-main
git remote remove photos-desktop
git remote add cli https://github.com/ente-io/cli.git
git fetch cli main
git checkout -b cli-main cli/main
mkdir cli
git mv `find . -maxdepth 1 | grep -v -e '^\.$' -e '^\.\/.git$' -e '^\.\/cli$'` cli
git commit -m 'Move into cli/'
git checkout main
git merge --allow-unrelated-histories cli-main
git branch -D cli-main
git remote remove cli
git remote add docs https://github.com/ente-io/docs.git
git fetch docs main
git checkout -b docs-main docs/main
mkdir docs-1
git mv `find . -maxdepth 1 | grep -v -e '^\.$' -e '^\.\/.git$' -e '^\.\/docs-1$'` docs-1
git mv docs-1 docs
git commit -m 'Move into docs/'
git checkout main
git merge --allow-unrelated-histories docs-main
git branch -D docs-main
git remote remove docs
```
2024-03-01 07:31:41 +00:00
|
|
|
# Contributing
|
|
|
|
|
|
|
|
|
|
First and foremost, thank you for your interest in contributing to Ente 🙏
|
|
|
|
|
|
|
|
|
|
There are many ways to contribute, and most of them don't require writing code.
|
|
|
|
|
|
|
|
|
|
* [Spread the word](#spread-the-word)
|
|
|
|
|
* [Engage with the community](#engage-with-the-community)
|
|
|
|
|
* [Translate](#translate)
|
|
|
|
|
* [Document](#document)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Spread the word
|
|
|
|
|
|
|
|
|
|
This is perhaps the most impactful contribution you can make. Spread the word.
|
|
|
|
|
Online on your favorite social media channels. Offline to your friends and
|
|
|
|
|
family who are looking for a privacy-friendly alternative to big tech.
|
|
|
|
|
|
|
|
|
|
## Engage with the community
|
|
|
|
|
|
|
|
|
|
Just hang around, enjoy the vibe. Answer someone's query on our
|
|
|
|
|
[Discord](https://discord.gg/z2YVKkycX3), or pile on in the sporadic #off-topic
|
|
|
|
|
rants there. Chuckle (or wince!) at our [Twitter](https://twitter.com/enteio)
|
|
|
|
|
memes. Suggest a new feature in our [Github
|
|
|
|
|
Discussions](https://github.com/ente-io/ente/discussions/new?category=feature-requests),
|
|
|
|
|
or upvote the existing ones that you feel we should focus on first. Provide your
|
|
|
|
|
opinion on existing threads.
|
|
|
|
|
|
|
|
|
|
These might seem like small things, but it provides us energy. Knowing that
|
|
|
|
|
there is a community of people who care for what we are building.
|
|
|
|
|
|
|
|
|
|
## Translate
|
|
|
|
|
|
|
|
|
|
If you're interested in helping out with translation, please visit our Crowdin
|
|
|
|
|
projects to get started:
|
|
|
|
|
|
|
|
|
|
| Project | |
|
|
|
|
|
| ------------- | ------------- |
|
|
|
|
|
| [Auth](https://crowdin.com/project/ente-authenticator-app) | [](https://crowdin.com/project/ente-authenticator-app) |
|
|
|
|
|
| [Photos](https://crowdin.com/project/ente-photos-app) | [](https://crowdin.com/project/ente-photos-app) |
|
|
|
|
|
| [Photos Web / Desktop](https://crowdin.com/project/ente-photos-web) | [](https://crowdin.com/project/ente-photos-web) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
If your language is not listed for translation, please [create a GitHub
|
2024-03-05 10:00:17 +00:00
|
|
|
issue](https://github.com/ente-io/ente/issues/new?title=Request+for+New+Language+Translation&body=Language+name%3A+%0AProject%3A+auth%2Fphotos%2Fboth)
|
Move to monorepo
Move all of our code into a monorepo in preparation of open sourcing our server.
First I describe the general plan, then later I've kept an exact log of the
commands that I used. This was all done prior to this commit, but this commit
(that introduces the various top level files) seems like a good way to summarize
the entire process.
Clone auth. Auth is our base repository.
```sh
git clone https://github.com/ente-io/auth.git && cd auth
```
Move all of auth's files into `auth/`.
```sh
mkdir auth
git mv `find . -maxdepth 1 | grep -v -e '\.$' -e '\.\/.git$' -e '\.\/auth$'` auth
git commit -m 'Move into auth/'
```
Add photos-web as a new remote, and fetch its main.
```sh
git remote add photos-web https://github.com/ente-io/photos-web.git
git fetch photos-web main
```
Switch to main of web-photos.
```sh
git checkout -b photos-web-main photos-web/main
```
Move all of its files into `web` (note, the find now has an extra exclusion for
`web`, but we keep all the old ones too):
```sh
mkdir web
git mv `find . -maxdepth 1 | grep -v -e '^\.$' -e '^\.\/.git$' -e '^\.\/auth$' -e '^\.\/web$'` web
git commit -m 'Move into web/'
```
Switch back to main main, and merge the photos-web branch. The
`--allow-unrelated-histories` flag is needed (since these two branches don't
have any previous common ancestor).
```sh
git checkout main
git merge --allow-unrelated-histories photos-web-main
```
That's it. We then repeat this process for all the other repositories that we
need to bring in.
There is no magic involved here, so regular git commands will continue working.
However, all the files get renamed, so to track the git history prior to this
rename commit we'll need to pass the `--follow` flag.
git log --follow -p -- auth/migration-guides/encrypted_export.md
For some file names like README.md which exist in multiple repositories, this
doesn't seem to work so good (I don't fully understand why). For example,
`git log --follow -p -- auth/README.md lists the changes to all the READMEs,
not just the auth README.md.
```sh
git clone https://github.com/ente-io/auth.git ente
cd ente
mkdir auth
git mv `find . -maxdepth 1 | grep -v -e '\.$' -e '\.\/.git$' -e '\.\/auth$'` auth
git commit -m 'Move into auth/'
git remote add photos-web https://github.com/ente-io/photos-web.git
git fetch photos-web main
git checkout -b photos-web-main photos-web/main
mkdir web
git mv `find . -maxdepth 1 | grep -v -e '^\.$' -e '^\.\/.git$' -e '^\.\/auth$' -e '^\.\/web$'` web
git commit -m 'Move into web/'
git checkout main
git merge --allow-unrelated-histories photos-web-main
git branch -D photos-web-main
git remote remove photos-web
git remote add photos-app https://github.com/ente-io/photos-app.git
git fetch photos-app main
git checkout -b photos-app-main photos-app/main
mkdir mobile
git mv `find . -maxdepth 1 | grep -v -e '^\.$' -e '^\.\/.git$' -e '^\.\/auth$' -e '^\.\/web$' -e '^\.\/mobile$'` mobile
git commit -m 'Move into mobile/'
git checkout main
git merge --allow-unrelated-histories photos-app-main
git branch -D photos-app-main
git remote remove photos-app
git remote add photos-desktop https://github.com/ente-io/photos-desktop.git
git fetch photos-desktop main
git checkout -b photos-desktop-main photos-desktop/main
mkdir desktop
git mv `find . -maxdepth 1 | grep -v -e '^\.$' -e '^\.\/.git$' -e '^\./.gitmodules$' -e '^\.\/desktop$'` desktop
git mv .gitmodules desktop
git commit -m 'Move into desktop/'
git checkout main
git merge --allow-unrelated-histories photos-desktop-main
git branch -D photos-desktop-main
git remote remove photos-desktop
git remote add cli https://github.com/ente-io/cli.git
git fetch cli main
git checkout -b cli-main cli/main
mkdir cli
git mv `find . -maxdepth 1 | grep -v -e '^\.$' -e '^\.\/.git$' -e '^\.\/cli$'` cli
git commit -m 'Move into cli/'
git checkout main
git merge --allow-unrelated-histories cli-main
git branch -D cli-main
git remote remove cli
git remote add docs https://github.com/ente-io/docs.git
git fetch docs main
git checkout -b docs-main docs/main
mkdir docs-1
git mv `find . -maxdepth 1 | grep -v -e '^\.$' -e '^\.\/.git$' -e '^\.\/docs-1$'` docs-1
git mv docs-1 docs
git commit -m 'Move into docs/'
git checkout main
git merge --allow-unrelated-histories docs-main
git branch -D docs-main
git remote remove docs
```
2024-03-01 07:31:41 +00:00
|
|
|
to have it added. It is okay to have partial translations. Once ~90% of the
|
|
|
|
|
strings in a language get translated, we will start surfacing it in the apps.
|
|
|
|
|
|
|
|
|
|
Thank you for your support.
|
|
|
|
|
|
|
|
|
|
## Document
|
|
|
|
|
|
|
|
|
|
_Coming soon!_
|
|
|
|
|
|
|
|
|
|
The help guides and FAQs for users of Ente products are also open source, and
|
|
|
|
|
can be edited in a wiki-esque manner by our community members. More than the
|
|
|
|
|
quantity, we feel this helps improve the quality and approachability of the
|
|
|
|
|
documentation by bringing in more diverse viewpoints and familiarity levels.
|
|
|
|
|
|
|
|
|
|
## Code contributions
|
|
|
|
|
|
|
|
|
|
If you'd like to contribute code, it is best to start small.
|
|
|
|
|
|
|
|
|
|
Each of the individual product/platform specific directories in this repository
|
|
|
|
|
have instructions on setting up a dev environment and making changes. The issues
|
|
|
|
|
labelled "good first issues" should be good starting points. Once you have a
|
|
|
|
|
bearing, you can head on to issues labelled "help wanted".
|
|
|
|
|
|
|
|
|
|
If you're planning on adding a new feature or making any other substantial
|
|
|
|
|
change, please [discuss it with
|
|
|
|
|
us](https://github.com/ente-io/ente/discussions). Discussing your idea with us
|
|
|
|
|
first ensures that everyone is on the same page before you start working on your
|
|
|
|
|
change.
|
|
|
|
|
|
|
|
|
|
## Star
|
|
|
|
|
|
|
|
|
|
If you haven't already done so, consider [starring this
|
|
|
|
|
repository](https://github.com/ente-io/ente/stargazers).
|