revanced-cli/CONTRIBUTING.md
2023-09-23 16:32:11 +02:00

3.7 KiB


                           

Continuing the legacy of Vanced

📙 ReVanced CLI contribution guidelines

This document describes how to contribute to ReVanced CLI.

📖 Resources to help you get started

  • The documentation explains how to use ReVanced CLI
  • Our backlog is where we keep track of what we're working on
  • Issues are where we keep track of bugs and feature requests

🙏 Submitting a feature request

Features can be requested by opening an issue using the Feature request issue template.

Note

Requests can be accepted or rejected at the discretion of maintainers of ReVanced CLI. Good motivation has to be provided for a request to be accepted.

🐞 Submitting a bug report

If you encounter a bug while using ReVanced CLI, open an issue using the Bug report issue template.

📝 How to contribute

  1. Before contributing, it is recommended to open an issue to discuss your change with the maintainers of ReVanced CLI. This will help you determine whether your change is acceptable and whether it is worth your time to implement it
  2. Development happens on the dev branch. Fork the repository and create your branch from dev
  3. Commit your changes.
  4. Submit a pull request to the dev branch of the repository and reference issues that your pull request closes in the description of your pull request
  5. Our team will review your pull request and provide feedback. Once your pull request is approved, it will be merged into the dev branch and will be included in the next release of ReVanced CLI

❤️ Thank you for considering contributing to ReVanced CLI, ReVanced