35 lines
1.7 KiB
Markdown
35 lines
1.7 KiB
Markdown
# 👋 Contribution guidelines
|
|
|
|
This document describes how to contribute to Revenge bundle.
|
|
|
|
## 📖 Resources to help you get started
|
|
|
|
* [Issues](https://github.com/revenge-mod/revenge-bundle/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/revenge-mod/revenge-bundle/issues/new?assignees=&labels=Feature+request&projects=&template=feature_request.yml&title=feat%3A+).
|
|
|
|
> **Note**
|
|
> Requests can be accepted or rejected at the discretion of maintainers of Revenge bundle.
|
|
> Good motivation has to be provided for a request to be accepted.
|
|
|
|
## 🐞 Submitting a bug report
|
|
|
|
If you encounter a bug while using Revenge bundle, open an issue using the
|
|
[Bug report issue template](https://github.com/revenge-mod/revenge-bundle/issues/new?assignees=&labels=Bug+report&projects=&template=bug_report.yml&title=bug%3A+).
|
|
|
|
## 📝 How to contribute
|
|
|
|
1. Before contributing, it is recommended to open an issue to discuss your change
|
|
with the maintainers of Revenge bundle. 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 Revenge bundle
|
|
|
|
❤️ Thank you for considering contributing to Revenge bundle
|