Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 3554877a authored by Romain Hunault's avatar Romain Hunault 💻
Browse files

feat: create contribute part

parent bdf804e5
Loading
Loading
Loading
Loading
+26 −0
Original line number Diff line number Diff line
# Contribute to /e/OS and Murena Workspace

You can help /e/OS grow in many different ways, from sharing your story to building devices and services. Pick the path that best fits your time, skills, and comfort level—below is a progression from the simplest ways to contribute to the most involved.

## Start small (share and support)

- **Share your experience:** Tell us what /e/OS means to you and we will amplify your story on our social channels and newsletters. [Read user testimonies](testimonies).
- **Support /e/:** Fuel development and infrastructure by backing the project financially. [Support /e/](support-e).
- **Volunteer locally:** Host install parties, talk about privacy, or represent /e/OS at events. [Join the volunteer community](volunteer).

## Help translate and localize

- **Translate:** Learn how to join the translation team and use Weblate to refine the user experience in your language. [Become a translator](translate).

## Test & report

- **Test builds:** Flash preview builds, follow our QA process, and share detailed feedback. [Join the tester community](tester).
- **Report issues:** Found a bug? File it on GitLab with logs, then follow the troubleshooting checklist so the developers can reproduce it quickly. [Report an issue](report-issue).

## Build & lead

- **Projects:** Pick an open-source project that matches your skills (microG, Nextcloud, Searx, etc.) or help with documentation. [Explore contributor projects](projects).
- **Become a ROM Maintainer:** If you build and ship ROMs, this is your track. [Become a ROM maintainer](rom-maintainer).
- **Job openings:** Looking for full-time work? Check the current roles and apply. [Murena jobs](jobs).

Need help choosing where to start? Send a note to <join@murena.io> with your interests and availability and we will point you to the right team.
+3 −0
Original line number Diff line number Diff line
# Murena job offers

Looking for full-time work to grow the /e/OS ecosystem? Browse our openings at [https://murena.com/jobs/](https://murena.com/jobs/).
+39 −0
Original line number Diff line number Diff line
# Projects looking for contributors

Murena and /e/OS welcome contributions from everyone. Pick a project, share your skills, and help shape the ecosystem.

## Open positions

Full-time roles are posted on the [Murena jobs page](https://murena.com/jobs/). Browse the list and apply through the portal.

## Specific projects that need help

- **microG:** Help replace Google services with microG, explore fixes, and move the project forward on [GitHub](https://github.com/microg/).
- **Testing:** Join the volunteer testing team to get early builds and hunt bugs. [Read the tester guide](tester).
- **Fix an issue:** Browse open issues on GitLab and choose one you can resolve: [pick an issue](https://gitlab.e.foundation/groups/e/-/issues).
- **OpenCamera fork:** We are improving camera behavior on certain devices. Contact us (see below) if you can help stabilize or fork the app.
- **Personal assistant (Elivia):** We need ASR, conversational AI, and deep-learning experts to grow our privacy-first assistant. Explore the project at [elivia](https://gitlab.e.foundation/e/elivia) and reach out if you can contribute.
- **ROM development:** If you build for Qualcomm or MediaTek chipsets, follow the [ROM maintainer guide](rom-maintainer) and contact the team to become a maintainer.

## Major /e/OS-related initiatives

/e/OS builds upon multiple open-source foundations:

- **LineageOS:** Contribute upstream to improve hardware support, and it will benefit /e/OS devices. [LineageOS contribution](https://lineageos.org/).
- **Searx:** Improve the unified search engine we ship as the default at [spot.murena.io](https://spot.murena.io). [Contribute to Searx](https://asciimoo.github.io/searx/).
- **Exodus Privacy:** Help the non-profit track abusive permissions, share data, or donate directly. [Exodus Privacy contributions](https://exodus-privacy.eu.org/).
- **NextCloud:** The Murena cloud relies on NextCloud; your bug fixes or feature work helps the online storage, calendar, and notes services. [Contribute to NextCloud](https://nextcloud.com/contribute/).

## Is it paid?

Most contributions are voluntary, but if you can commit to a larger delivery in a short timeframe, we may discuss a bounty or temporary paid collaboration. Email us to open that conversation.

## How to contact us

Send a message to <join@murena.io> with a clear subject line (for example: “OpenCamera development”). Include:

- The project you want to help with
- Your relevant skills and experience
- What you would like to deliver (fix, feature, documentation)

We will respond with next steps and point you to the right GitLab issue or team.
+37 −0
Original line number Diff line number Diff line
# Report an issue

Follow this process so the developers can reproduce bugs and send fixes faster.

## Connect to our GitLab server

- Log in at [https://gitlab.e.foundation/users/sign_in](https://gitlab.e.foundation/users/sign_in).
- If you do not have an account yet, [create one](https://gitlab.e.foundation/e).

## Search before filing

- Browse the issue tracker at [https://gitlab.e.foundation/e/backlog/-/issues](https://gitlab.e.foundation/e/backlog/-/issues).
- Type your bug description in the search field to verify it has not been reported already.
- If the search does not return anything relevant, proceed to create a new issue.

## Create a new issue

- Choose an issue template from the **Choose a template** dropdown and click **Apply template**.
- Enter a clear title and fill in every field requested by the template.
- Always [attach logs](/support-topics/create-a-log) when possible to help developers debug faster.
- Click **Submit issue** when you are ready.

## Facing an error while creating a GitLab ID?

- We limit the email domains allowed on GitLab to keep fake accounts out.
- If your email is not listed, sign up for a Murena Workspace account at [https://murena.io/apps/ecloud-accounts/accounts/signup](https://murena.io/apps/ecloud-accounts/accounts/signup) and register with that address.

## Troubleshooting questions & suggestions

- **Should I send the bug via email?** No—please use the GitLab issue process above. Email or IM is not efficient and slows down triage.
- **How do I handle feature requests or suggestions?** Open a topic in the [feature request forum](https://community.e.foundation/c/e-smartphone-operating-system/request-a-feature/82) so other users can comment. The team reviews popular requests for roadmap inclusion.
- **Privacy suggestions?** Email <privacychallenge@murena.io> with your idea.

## Syntax & source references

- [Issue template syntax](https://docs.gitlab.com/ee/user/project/description_templates.html#setting-a-default-template-for-issues-and-merge-requests)
- [GitLab Markdown guide](https://docs.gitlab.com/ee/user/markdown.html)
+33 −0
Original line number Diff line number Diff line
# ROM Maintainer program

The ROM Maintainer builds, tests, and releases the /e/OS image for a particular device. They are responsible for hardware-specific issues and collaborate with the team to keep the device working.

## Responsibilities

- Build /e/OS from the sources available on the [/e/OS GitLab](https://gitlab.e.foundation/e/os/android).
- Port device trees when LineageOS support is missing and keep them synced with /e/OS.
- Use the same application set as the official GitLab repository without introducing additional changes.
- Test the ROM on your own device, verify calls, messaging, and daily tasks, then release the build to users.
- Handle device-specific issues that come up during testing before publishing the final build.

## How to become a ROM Maintainer

### Prerequisites

You should be experienced with building, flashing, and debugging custom ROMs.

### Steps

1. Build an unofficial /e/OS ROM using the sources from [/e/OS GitLab](https://gitlab.e.foundation/e/os/android) using Docker or a repo sync.
2. Flash the build on your device and test it thoroughly (calls, messages, Wi-Fi, etc.).
3. Share the build on our [forum unofficial builds section](https://community.e.foundation/c/e-devices/unofficial-builds/92) and start a new thread.
4. Collect feedback from users and iterate on the build.
5. Once you have enough positive reports, email <join@murena.io> with a subject like “ROM Maintainer Mediatek <device>” and the team will guide you through the next steps.

## Community and support

You will join a private Telegram channel where maintainers coordinate. If you need to step down, just inform the team so they can plan for alternate builds.

## More questions?

Drop a post on the [Murena forum](https://community.e.foundation/) and we will follow up as soon as possible.
Loading