Contributing to retrokit
First and foremost, thanks for taking the time to contribute!
All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them.
And if you like the project, but just don’t have time to contribute, that’s fine! There are other easy ways to support the project and show your appreciation, which I would also be very happy about:
- Star the project
- Tweet about it
- Refer this project in your project’s readme
- Mention the project at local meetups and tell your friends/colleagues
Table of Contents
Code of Conduct
This project and everyone participating in it is governed by the Code of Conduct.
I have a question!
If you want to ask a question, we assume that you have read the available documentation.
Before you ask a question, it’s best to search for existing issues that might help you. In case you’ve found a suitable issue and still need clarification, you can write your question in that issue.
If you still feel the need to ask a question and need clarification, it’s recommended to:
- Open an issue.
- Provide as much context as you can about what you’re running into
- Provide project and hardware versions (RetroPie, Raspberry Pi 4b, etc), depending on what seems relevant
I want to contribute!
Legal Notice
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
Reporting Bugs
A good bug report shouldn’t leave others needing to chase you down for more information. Investigate carefully, collect information and describe the issue in detail. Some details that can help get your bug fixed as soon as possible include:
- Make sure that you are using the latest version
- Collect information about the bug, such as stack trace, os version, etc.
- Any commands that you ran
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
Suggesting Enhancements
Have an idea for an enhancement? Great! Before you submit a suggestion:
- Make sure that you are using the latest version
- Read the docs carefully and to see if it’s already covered
- Search the issues to see if the enhancement has already been suggested
When submitting a suggestion:
- Use a clear and descriptive title for the issue to identify the suggestion
- Provide a description of the enhancement in as many details as possible
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Explain why this enhancement would be useful to most users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
Attribution
This guide is based on contributing.md!