you successfully reached here 🎉
The following is a set of guidelines for contributing to ubuntu-on-android and its sub-repos
this project and everyone's participation is governed by code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected]
we have a official Discord server & GitHub discussions. reach us out there for any query regarding udroid
to have a chit-chat with us ( join Discord )
ubuntu-on-android repository aimed to custom ubuntu tarballs with the pre-installed applications for general usage. The idea is to provide pc like experience by keeping in mind about drawbacks of proot ( which udroid works on ). For starters, ubuntu-on-android doesn't hold the major code part of udroid. ubuntu-on-android has the installer, some beginner markdown guides, and preview images. here is the list of all repos and their description that are part of udroid.
fs-manager-udroid holds scripts for managing udroid and some snippet codes for installing or setting up the common application.
this repository contains all the documentation written by developers and contributors of udroid
fs-cook repository is the most active repo in udroid. It aims to make the Linux building process easier for shipping Linux tarballs to users
for starters, you can follow the basic GitHub guide here.
When submitting a pull request make sure to add a good title and description to it. using images is encouraged too
Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
$ git commit -m "A summary of the commit
>
> A paragraph describing what changed and its impact."
Start reading our code and you'll get the hang of it. We optimize for readability:
- use 4-6 spaces for intending to bash
- follow directory rules in all cases ( images should go in directories named similar to
assetsorimg) - use code beautification tools for better look and readability
- This is open-source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers, the goal is to make the ride as smooth as possible.