Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (45 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

71 lines (45 loc) · 2.29 KB

Contributing

Thanks for wanting to contribute!

You can help make this list better for everyone by adding apps you've tested on GrapheneOS that work properly without Google Play Services.

This document explains the preferred workflow for adding apps to this list.

Before you begin

IMPORTANT: If you only want one app added to the list, just open an issue with the title of the app.

Creating a Pull Request is better if you want to contribute more than one app to the list at a time.
If your changes are significant, open an issue first to discuss plans.

Workflow

  1. Fork the repository

  2. Create a branch in your fork
    NOTE: use a descriptive name, e.g. add/<app> or fix/<issue-number>-short-desc.

  3. Make your changes on that branch

  4. Push the branch to your fork and open a Pull Request (PR) against this repository's default branch.

    TIP: If you used the web editor, GitHub will create a fork and open a PR for you automatically.

  5. Fill out the PR template to help reviewers

If you have write access

You can create a branch directly in this repo and open a PR; still follow the checklist and format rules.

Branch & commit guidelines

Keep commits focused and atomic (one purpose per commit).

Commit message style examples:

  • add app <app>
  • fix bad link for <app>
  • bump metadata,
  • etc.

Rebase/squash as requested by reviewers

What to include in your PR

A clear title and the filled PR template.
Also remark if any special settings are needed to get the app to work.

If there is an existing issue which the PR resolves, please link it via the Closes keyword.

Review

Maintainers will review and may request changes

Tips to make your PR easy to merge

Here are some things you can do to increase the chances of a merge:

  • Follow the exact entry format
  • Keep your PR small and focused.

App Submission Requirements

At the very least, any app submitted must fulfil the following criteria:

  • It must function properly for the most part without Play Services
  • be a lawful app on the Play Store
  • be an app that you tested yourself and verified that works without Play Services.

Questions

If you are unsure about the format or have a question, please open an issue.
Thanks for contributing!