mirror of
https://github.com/kavishdevar/librepods.git
synced 2026-01-29 06:10:52 +00:00
70 lines
3.4 KiB
Markdown
70 lines
3.4 KiB
Markdown
# Welcome to LibrePods contributing guide <!-- omit in toc -->
|
||
|
||
Thank you for considering a contribution to LibrePods! Your support helps bring Apple-exclusive AirPods features to Linux and Android.
|
||
|
||
Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectful.
|
||
|
||
This guide provides an overview of the contribution workflow, from opening an issue to creating and reviewing a pull request (PR).
|
||
|
||
## New contributor guide
|
||
|
||
To get an overview of the project, read the [README](./README.md). Here are some resources to help you get started with open-source contributions:
|
||
|
||
- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
|
||
- [Set up Git](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git)
|
||
- [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow)
|
||
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
|
||
|
||
## Getting started
|
||
|
||
To navigate our codebase with confidence, see the [README](./README.md) for setup instructions and usage details. We accept various types of contributions, which don’t always require writing code (like translations).
|
||
|
||
To develop for the Android App, Android Studio is the preferred IDE. And you can use any IDE for the linux program, it is just python!
|
||
|
||
### Issues
|
||
|
||
#### Create a new issue
|
||
|
||
If you find a bug or want to suggest a feature, check if an issue already exists by searching through our [existing issues](https://github.com/kavishdevar/librepods/issues). If no relevant issue exists, open a new one and fill in the details.
|
||
|
||
#### Solve an issue
|
||
|
||
Browse our [issues list](https://github.com/kavishdevar/librepods/issues) to find an interesting issue to work on. Use labels to filter issues and pick one that matches your expertise. If you’d like to work on an issue, open a PR with your solution.
|
||
|
||
### Make Changes
|
||
|
||
#### Make changes locally
|
||
|
||
1. Fork the repository and clone it to your local environment.
|
||
```
|
||
git clone https://github.com/kavishdevar/librepods.git
|
||
cd AirPods-Like-Normal
|
||
```
|
||
2. Create a working branch to start your changes.
|
||
```
|
||
git checkout -b your-feature-branch
|
||
```
|
||
3. Make your changes, following the existing style and structure.
|
||
|
||
4. Test your changes to ensure they work as expected and do not introduce new issues.
|
||
|
||
### Commit your changes
|
||
|
||
Commit your changes with a descriptive message.
|
||
|
||
### Pull Request
|
||
|
||
When your changes are ready, create a pull request (PR):
|
||
- Fill out the PR template to help reviewers understand your changes.
|
||
- If your PR is related to an issue, don’t forget to [link your PR to it](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
|
||
- Enable the checkbox to allow maintainers to edit your PR, so any required changes can be merged easily.
|
||
|
||
Once your PR is open, a team member will review it. They may ask questions or request additional information.
|
||
|
||
- If changes are requested, apply them in your fork and commit them to the PR branch.
|
||
- Mark conversations as resolved as you apply feedback.
|
||
- For merge conflicts, follow this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to resolve them.
|
||
|
||
### Your PR is merged!
|
||
|
||
Congratulations! :tada: Once merged, your contributions will be publicly available in LibrePods. |