diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..d44fefaa --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,85 @@ +

+ + + + +
+ + +     + + + + + +     + + +     + + +     + + +     + + + + + +     + + + +
+
+ Continuing the legacy of Vanced +

+ +# 📙 Contributing guidelines +This document describes how to contribute to ReVanced Manager. + +## 📖 Resources to help you get started +* The [documentation](/docs/README.md) provides the steps by steps tutorial to compile ReVanced Manager from scratch +* [Our backlog](https://github.com/orgs/ReVanced/projects/12) is where we keep track of what we're working on +* [Issues](https://github.com/ReVanced/revanced-patches/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](https://github.com/ReVanced/revanced-manager/issues/new). + +> [!NOTE] +> We may rejected your request at the discretion of maintainers, +> please provides good motivation for a request to be accepted. + +## 🐞 Submitting a bug report +If you encounter a bug while using the ReVanced Manager app, open an issue using the +[Bug report issue template](https://github.com/ReVanced/revanced-manager/issues/new). + +## 📝 How to contribute + +> [!NOTE] +> It's worth noting that we recommended that you discuss your changes with +> the maintainers of ReVanced Manager before contributing. +> This will help you determine whether your change is acceptable. + +1. Fork the repository and create your branch from `dev` +2. Make sure that the commit name are clear and concise as possible and commit your changes. + If you have never contributed to this repository before, it's recommended to follow the rules in the [documentation](/docs/README.md) +3. Open a pull request to the `dev` branch and reference issues with `fix: #No.` if needed. +4. The maintainers of ReVanced Manager will review and provide suggestions. + Once your PR is approved and merged, it will be included in the next release of ReVanced Manager + +## 🤚 I want to contribute but don't know how to code + +We accept translation at Crowdin + + + +❤️ Thank you for considering contributing to ReVanced Manager diff --git a/README.md b/README.md index 32374a58..e90ec587 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@
- +     @@ -32,7 +32,7 @@ - +