TheSuperDragon
6d7771ea4e
This commit updates existing documentation to use the new website docs.lawnchair.app.
32 lines
2.4 KiB
Markdown
32 lines
2.4 KiB
Markdown
# Contributing to Lawnchair
|
|
|
|
Thank you for your interest in contributing to the Lawnchair project. This document provides general reminders and directs you to our official, living documentation hub at [docs.lawnchair.app](https://docs.lawnchair.app).
|
|
|
|
## General reminders
|
|
|
|
Before participating in any area of the project, please keep these core guidelines in mind:
|
|
|
|
* Adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) during all interactions.
|
|
* Always search our [GitHub issue tracker](https://github.com/LawnchairLauncher/lawnchair/issues) to see if a bug has already been reported or a feature requested before opening a new issue.
|
|
* Avoid using the issue tracker for personal support. If you need help, please visit our [community channels](https://docs.lawnchair.app/project-and-community/get-involved/community-channels) on Telegram or Discord.
|
|
|
|
### Contributing non-code
|
|
|
|
You do not need to write code to make a significant impact on Lawnchair. We welcome and encourage several forms of non-code contributions:
|
|
|
|
* You can help make Lawnchair accessible to a global audience by contributing translations through [Lawnchair on Crowdin](https://lawnchair.crowdin.com/lawnchair).
|
|
* You can help make development sustainable by [donating to the project](https://opencollective.com/lawnchair/).
|
|
* You can help maintain a clean and effective issue tracker by joining our [triaging issues](https://docs.lawnchair.app/community/get-involved/triage-issues).
|
|
* You can help keep our documentation accurate and clear by contributing directly to our [documentation files](https://docs.lawnchair.app/community/get-involved/writing-documentation).
|
|
|
|
### Contributing code
|
|
|
|
Lawnchair is built on a highly complex, AOSP-derived foundation. Because of this, direct code contribution is challenging and may not be suitable for beginners.
|
|
|
|
Before setting up your environment or writing any code, please read our [onboarding preface](https://docs.lawnchair.app/developers) to understand the unique challenges of this codebase.
|
|
|
|
If you are ready to write code, refer to [our official developer guides](https://docs.lawnchair.app/developers) on our documentation site:
|
|
|
|
* [Setup your build environment](https://docs.lawnchair.app/developers/introduction/get-started)
|
|
* [Understand our development workflow](https://docs.lawnchair.app/developers/standards/development-workflow)
|
|
* [Follow code standards](https://docs.lawnchair.app/developer-guide/standards/coding-standards) |