-
Notifications
You must be signed in to change notification settings - Fork 112
docs: streamline README and add missing community & compliance files #309
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
indpriyanshuraj
wants to merge
1
commit into
LiteLDev:main
Choose a base branch
from
indpriyanshuraj:docs/improve-readme-with-compliance
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| # Contributor Covenant 3.0 Code of Conduct | ||
|
|
||
| ## Our Pledge | ||
|
|
||
| We pledge to make our community welcoming, safe, and equitable for all. | ||
|
|
||
| We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant. | ||
|
|
||
| ## Encouraged Behaviors | ||
|
|
||
| While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language. | ||
|
|
||
| With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including: | ||
|
|
||
| 1. Respecting the **purpose of our community**, our activities, and our ways of gathering. | ||
| 2. Engaging **kindly and honestly** with others. | ||
| 3. Respecting **different viewpoints** and experiences. | ||
| 4. **Taking responsibility** for our actions and contributions. | ||
| 5. Gracefully giving and accepting **constructive feedback**. | ||
| 6. Committing to **repairing harm** when it occurs. | ||
| 7. Behaving in other ways that promote and sustain the **well-being of our community**. | ||
|
|
||
|
|
||
| ## Restricted Behaviors | ||
|
|
||
| We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct. | ||
|
|
||
| 1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop. | ||
| 2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people. | ||
| 3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits. | ||
| 4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community. | ||
| 5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission. | ||
| 6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group. | ||
| 7. Behaving in other ways that **threaten the well-being** of our community. | ||
|
|
||
| ### Other Restrictions | ||
|
|
||
| 1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions. | ||
| 2. **Failing to credit sources.** Not properly crediting the sources of content you contribute. | ||
| 3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community. | ||
| 4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors. | ||
|
|
||
|
|
||
| ## Reporting an Issue | ||
|
|
||
| Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm. | ||
|
|
||
| When an incident does occur, it is important to report it promptly. To report a possible violation, you may use either of the following: | ||
|
|
||
| - **Email:** | ||
| [contact@levimc.org](mailto:contact@levimc.org) | ||
|
|
||
| <!-- | ||
| - **Discord:** | ||
| Open a private support ticket in the official community server: [https://discord.gg/v5R5P4vRZk](https://discord.gg/v5R5P4vRZk) | ||
| --> | ||
|
|
||
| Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution. | ||
|
|
||
|
|
||
| ## Addressing and Repairing Harm | ||
|
|
||
| If a violation of this Code of Conduct is reported, the following steps may be taken based on the severity of the incident. | ||
|
|
||
| 1) **Warning** | ||
| 1) Event: A single incident or minor violation. | ||
| 2) Consequence: A private, written warning from the repository maintainer. | ||
| 3) Repair: A private written apology and acknowledgement of responsibility. | ||
|
|
||
| 2) **Temporarily Limited Activities** | ||
| 1) Event: A repeated violation after a warning, or a more serious first incident. | ||
| 2) Consequence: A time-limited cooldown from interactions in this repository, such as commenting on issues or pull requests. | ||
| 3) Repair: Reflection on actions and a commitment to respectful engagement before returning. | ||
|
|
||
| 3) **Permanent Ban** | ||
| 1) Event: Continued violations after warnings, or a single severe violation such as harassment or hate speech. | ||
| 2) Consequence: Permanent removal from all interactions in this repository, including issues, pull requests, and discussions. | ||
| 3) Repair: There is no possible repair in cases of this severity. | ||
|
|
||
| This enforcement ladder is a guideline. The repository maintainer reserves the right to use discretion based on the best interests of the community. | ||
|
|
||
| ## Scope | ||
|
|
||
| This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. | ||
|
|
||
|
|
||
| ## Attribution | ||
|
|
||
| This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/). | ||
|
|
||
| Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/) | ||
|
|
||
| For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,212 @@ | ||
| # Contributing to LeviLauncher | ||
|
|
||
| Thank you for your interest in **LeviLauncher**. This project depends on community participation to improve stability, usability, and long-term maintainability. | ||
|
|
||
| > **Project repository:** [https://github.com/LiteLDev/LeviLaunchroid](https://github.com/LiteLDev/LeviLaunchroid) | ||
|
|
||
| --- | ||
|
|
||
| ## Ways to Contribute | ||
|
|
||
| You can contribute by: | ||
|
|
||
| - Fixing bugs | ||
| - Improving performance | ||
| - Improving documentation | ||
| - Adding new launcher features | ||
| - Improving UI and UX | ||
| - Refactoring existing code | ||
| - Adding new language translations or improving existing ones | ||
| - Reporting reproducible bugs | ||
| - Reviewing pull requests | ||
| - Helping answer community questions | ||
|
|
||
| --- | ||
|
|
||
| ## Project Goals | ||
|
|
||
| LeviLauncher aims to remain: | ||
|
|
||
| - **Lightweight** | ||
| - **Stable** | ||
| - **Fast** | ||
| - **Easy to maintain** | ||
| - **Compatible with official Minecraft releases** | ||
|
|
||
| Please keep these goals in mind when proposing or implementing changes. | ||
|
|
||
| --- | ||
|
|
||
| ## Getting Started | ||
|
|
||
| Before contributing, review the repository structure, open issues, and existing pull requests to understand the current direction of development. | ||
|
|
||
| ### Development Prerequisites | ||
|
|
||
| - **Git** | ||
| - **Android Studio** | ||
| - **JDK 21 or higher** | ||
| - **Android SDK** (API 28+) | ||
| - Android 9.0+ device or emulator | ||
|
|
||
| ### Local Setup | ||
|
|
||
| ```sh | ||
| git clone https://github.com/LiteLDev/LeviLaunchroid.git | ||
| ``` | ||
|
|
||
| Open the project in Android Studio, allow Gradle to sync, then build and run the application. | ||
|
|
||
| --- | ||
|
|
||
| ## Branching | ||
|
|
||
| Create a separate branch for each contribution. | ||
|
|
||
| Examples: | ||
|
|
||
| - `feature/account-manager` | ||
| - `fix/crash-on-launch` | ||
| - `docs/update-readme` | ||
|
|
||
| --- | ||
|
|
||
| ## Translation Contributions | ||
|
|
||
| Localization is an important part of making LeviLauncher accessible to more users. | ||
|
|
||
| If you would like to contribute translations: | ||
|
|
||
| - Add support for a new language. | ||
| - Improve or update existing translations. | ||
| - Keep translations accurate and consistent with the English source. | ||
| - Verify translated strings before submitting a pull request. | ||
| - Preserve placeholders, formatting, and variables exactly as they appear in the source text. | ||
|
|
||
| --- | ||
|
|
||
| ## Contribution Standards | ||
|
|
||
| ### Code Quality | ||
|
|
||
| - Write clean, modular, and readable code. | ||
| - Follow the project's Kotlin and Java style. | ||
| - Keep changes focused. | ||
| - Avoid duplicated logic and unnecessary dependencies. | ||
|
|
||
| ### Commit Quality | ||
|
|
||
| - Use small, targeted commits. | ||
| - Write clear commit messages. | ||
| - Avoid mixing unrelated changes. | ||
|
|
||
| ### Documentation | ||
|
|
||
| Update documentation whenever behavior changes and document complex logic where appropriate. | ||
|
|
||
| ### Breaking Changes | ||
|
|
||
| Explain breaking changes and provide migration notes when necessary. | ||
|
|
||
| ### Dependency Policy | ||
|
|
||
| Prefer existing dependencies whenever possible. | ||
|
|
||
| --- | ||
|
|
||
| ## Testing Requirements | ||
|
|
||
| Before opening a pull request: | ||
|
|
||
| - Test on at least one device when possible. | ||
| - Verify compatibility. | ||
| - Confirm your changes do not introduce regressions. | ||
| - Test debug and release builds where applicable. | ||
|
|
||
| --- | ||
|
|
||
| ## Pull Requests | ||
|
|
||
| Include: | ||
|
|
||
| - Summary of changes | ||
| - Reason for the change | ||
| - Related issues | ||
| - Screenshots (if UI changes) | ||
| - Testing performed | ||
|
|
||
| > Keep pull requests focused and reasonably small. | ||
|
|
||
| Draft pull requests are welcome. | ||
|
|
||
| --- | ||
|
|
||
| ## Review Process | ||
|
|
||
| Reviews may request code improvements, documentation updates, testing, or design revisions. | ||
|
|
||
| > Submission does not guarantee acceptance. | ||
|
|
||
| --- | ||
|
|
||
| ## Large Contributions | ||
|
|
||
| For major architectural or feature changes, please open an issue for discussion before starting implementation. | ||
|
|
||
| --- | ||
|
|
||
| ## Issue Reporting | ||
|
|
||
| Should include: | ||
|
|
||
| - Device model | ||
| - Android version | ||
| - Minecraft version | ||
| - LeviLauncher version | ||
| - Reproduction steps | ||
| - Logs or screenshots | ||
|
|
||
| --- | ||
|
|
||
| ## Communication | ||
|
|
||
| Be respectful, constructive, and follow the project's Code of Conduct. | ||
|
|
||
| --- | ||
|
|
||
| ## Security | ||
|
|
||
| > Do **not** report security vulnerabilities publicly. | ||
|
|
||
| Please follow [SECURITY.md](SECURITY.md). | ||
|
|
||
| --- | ||
|
|
||
| ## Licensing | ||
|
|
||
| By submitting a contribution, you agree that it may be distributed under the project's license. | ||
|
|
||
| --- | ||
|
|
||
| ## Before Submitting | ||
|
|
||
| - Build successfully. | ||
| - Verify the application launches. | ||
| - Check for regressions. | ||
| - Ensure CI passes (if applicable). | ||
|
|
||
| --- | ||
|
|
||
| ## Related Documents | ||
|
|
||
| - [README.md](README.md) | ||
| - [SECURITY.md](SECURITY.md) | ||
| - [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) | ||
| - [LICENSE](LICENSE) | ||
| - [NOTICE](NOTICE) | ||
|
|
||
| --- | ||
|
|
||
| ## Thank You | ||
|
|
||
| Your contributions help keep LeviLauncher lightweight, reliable, and accessible. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| LeviLaunchroid | ||
| Copyright 2025-2026 LeviMC Team and Contributors | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.