Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 83 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [halitsever@protonmail.com](mailto:halitsever@protonmail.com). All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of actions.

**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
28 changes: 28 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Contributing

Thanks for taking the time to contribute. Bug reports, ideas, docs fixes and code are all welcome.

Before you start, please read the [Code of Conduct](CODE_OF_CONDUCT.md). If you found a security problem, follow the [security policy](SECURITY.md) instead of opening a public issue.

## Reporting bugs

Search the existing issues first. If nobody has reported it yet, open a new issue with the **Bug report** template and include the steps to reproduce it, what you expected to happen and what happened instead.

## Suggesting features

Open an issue with the **Feature request** template. Start with the problem you're trying to solve, then describe the solution you have in mind. For bigger changes, please wait until the direction is agreed on in the issue before writing code.

## Pull requests

1. Fork the repository and create a branch from `main`, for example `fix/empty-config`.
2. Keep the change focused. One fix or feature per pull request is easier to review.
3. Format your code with Prettier: `npx prettier --write .`
4. Update tests and docs if the change affects behavior.
5. Write commit messages in the [Conventional Commits](https://www.conventionalcommits.org/) style, for example `fix: handle empty config file`.
6. Open the pull request against `main`, fill in the template and link the issue it closes.

Small fixes like typos can go straight to a pull request without an issue.

## Questions

See [SUPPORT.md](SUPPORT.md).
19 changes: 19 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Security Policy

## Supported versions

Security fixes are only made for the latest release.

## Reporting a vulnerability

Please don't report security problems through public issues, discussions or pull requests.

Report them privately through [GitHub's private vulnerability reporting](https://github.com/halitsever/omodroid/security/advisories/new). If that isn't available, email [halitsever@protonmail.com](mailto:halitsever@protonmail.com).

A useful report includes:

- the affected version or commit
- steps or a proof of concept to reproduce the issue
- the impact you expect

You should get a first reply within a week. Once the issue is confirmed, a fix is released as soon as possible and you're credited in the advisory, unless you'd rather stay anonymous.
6 changes: 6 additions & 0 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Support

- **Bugs:** open an issue with the [Bug report](https://github.com/halitsever/omodroid/issues/new?template=bug_report.md) template.
- **Feature ideas:** open an issue with the [Feature request](https://github.com/halitsever/omodroid/issues/new?template=feature_request.md) template.
- **Questions:** open a [blank issue](https://github.com/halitsever/omodroid/issues/new) and describe what you're trying to do.
- **Security problems:** follow the [security policy](SECURITY.md). Please don't post them publicly.
Binary file added .github/social-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# AGENTS.md

omodroid is a planned Android launcher and overlay for the Omoda 5 (2023) infotainment head unit, for owners who want to customize it. The repo has no source code yet, only docs, license and CI.

## Verify a change

- CI (`.github/workflows/ci.yml`) runs one check: `npx -y prettier@3.6.2 --check .`
- Prettier reads `.prettierrc` (`printWidth: 180`) and covers Markdown and YAML too. Run `npx -y prettier@3.6.2 --write <file>` on every file you add or edit before pushing.

## Gotchas

- Describe only what the repo contains. Until code lands, README and docs say the project is at an early stage and list no features.

## Conventions

- Commit subjects in conventional-commit style, in English, subject line only: no body, no trailer.
- Work on a branch and open a PR against `main`. The owner merges.
- Write new text without emoji. Keep code comments short, one line where possible, and say why.
- The README follows the owner's template. Keep every image served from `halitsever-api.vercel.app` byte-for-byte; only the `title=` value of `api/repo-title` and the issue wrapper link may be corrected.
- Leave version bumps and releases to the owner.
21 changes: 13 additions & 8 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<p align="center" class="logo-section">
<img src="https://i.ibb.co/NrPh9xP/image.png" height="80" width="80"/>
<img src="https://i.ibb.co/NrPh9xP/image.png" height="80" width="80" alt="omodroid logo"/>
</br>
<img src="https://halitsever-api.vercel.app/api/repo-title?title=repo_name">
<img src="https://halitsever-api.vercel.app/api/repo-title?title=Omodroid">

<p align="center">
✋ Coming soon...<br>
Android launcher and overlay for the Omoda 5 (2023) infotainment head unit<br>
<br/>
<br/>
<img src="https://img.shields.io/github/sponsors/halitsever"/>
<img src="https://img.shields.io/github/sponsors/halitsever" alt="GitHub Sponsors"/>
</p>
<p align="center">
<a align="center" href="#">Documentation</a>
Expand All @@ -18,18 +18,23 @@
<img src="https://halitsever-api.vercel.app/api/details"/>
</p>

- 🧑‍💻 [**TODO**](#) - update docs
- **Early stage**: the repository does not contain source code yet. Watch or star it to follow the first release.

<p align="center" >
<img src="https://halitsever-api.vercel.app/api/installation"/>
</p>

Todo: update docs
There is no release yet. Install steps will be added together with the first build.

<p align="center" href="https://github.com/halitsever/repo_name/issues">
<p align="center" href="https://github.com/halitsever/omodroid/issues">
<img src="https://halitsever-api.vercel.app/api/issue"/>
</p>

<p align="center">
Found a bug or have an idea? Open an <a href="https://github.com/halitsever/omodroid/issues">issue</a>.<br/>
Read the <a href=".github/CONTRIBUTING.md">contributing guide</a> before sending a pull request.
</p>

<p align="center">
<img src="https://halitsever-api.vercel.app/api/sponsor"/>
</p>
Expand All @@ -39,5 +44,5 @@ Todo: update docs
</p>

<p align="center">
...
Released under the <a href="LICENSE">MIT License</a>.
</p>
15 changes: 15 additions & 0 deletions llms.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# omodroid

> Planned Android launcher and overlay for the Omoda 5 (2023) infotainment head unit (Chery Omoda). Early stage: the repository holds no source code or release yet.

There is nothing to install yet. Do not describe features, install steps or supported firmware versions; none are published.

## Docs

- [README](https://github.com/halitsever/omodroid/blob/main/Readme.md): project summary and current status
- [AGENTS.md](https://github.com/halitsever/omodroid/blob/main/AGENTS.md): CI check and conventions for contributors

## Optional

- [Source](https://github.com/halitsever/omodroid): repository
- [License](https://github.com/halitsever/omodroid/blob/main/LICENSE): MIT
Loading