LAB/rommapp_playnite-plugin
1
0
Fork 0
mirror of https://github.com/rommapp/playnite-plugin.git synced 2026-01-09 06:33:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

add CONTRIBUTING.md and update README.md to include contribution guidelines

Browse Source
This commit is contained in:
zurdi 2025-05-30 09:34:22 +00:00
parent 4828dc70f0
commit f6d823c55f
No known key found for this signature in database
GPG Key ID: 1CE7272F297B3AA4
2 changed files with 45 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,41 @@
# Contributing to RomM Playnite plugin
Thank you for considering contributing to RomM Playnite plugin! This document outlines some guidelines to help you get started with your contributions.
**If you're looking to implement a large feature or make significant changes to the project, it's best to open an issue first AND join the Discord to discuss your ideas with the maintainers.**
## Code of Conduct
Please note that this project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md). By participating in this project, you are expected to uphold this code.
## Contributing to the Docs
If you would like to contribute to the project's [documentation](https://docs.romm.app/latest/Integrations/Playnite-plugin/), open a pull request against [the docs repo](https://github.com/rommapp/docs). We welcome any contributions that help improve the documentation (new pages, updates, or corrections).
## How to Contribute Code
**WIP**
## Pull Request Guidelines
- Make sure your code follows the project's coding standards.
- Test your changes locally before opening a pull request.
- Update the documentation if necessary.
- Ensure all existing tests pass, and add new tests for new functionality.
- Use clear and descriptive titles and descriptions for your pull requests.
## Code Style
**WIP**
## Issue Reporting
If you encounter any bugs or have suggestions for improvements, please [create an issue](https://github.com/rommapp/playnite-plugin/issues) on GitHub. Provide as much detail as possible, including steps to reproduce the issue if applicable.
## Licensing
By contributing to RomM Playnite plugin, you agree that your contributions will be licensed under the project's [LICENSE](LICENSE).
---
Thank you for contributing to RomM Playnite plugin! Your help is greatly appreciated.

4
README.md
View File

@ -29,6 +29,10 @@ This plugin allows you to import your RomM library into Playnite. It queries the
To install and configure the RomM playnite plugin, check out the [Installation Guide][docs-installation-guide]
## Contributing
To contribute to RomM Playnite plugin, please check [Contribution Guide](./CONTRIBUTING.md)
## Support
If you have any issues with the plugin, please [open an issue](https://github.com/rommapp/playnite-plugin/issues/new) in this repository. If the issue is with RomM itself, open an issue in the [RomM repository](https://github.com/rommapp/romm/issues/new/choose).