👍🎉 First off, thanks for taking the time to contribute! 🎉👍
This library adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code.
The following is a set of guidelines for contributing to UsbSerialForAndroid.
These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.
This contribution guide was based on one used by the Electron project.
Issues are created here.
The three most important pieces of information needed to evaluate the report are a description of the bug, the hardware used, and a simple test case to recreate it. It is easier to fix a bug if it can be reproduced. See How to create a Minimal, Complete, and Verifiable example.
We will do our best to repond to reported issues that provide information that we can help with. This is not a commercial product and we make no claims or offers to provide any support whatsoever.
If you have a code fix or suggestion, we are only looking at changes submitted as pull requests.
Bug reports will be closed if no details are included. If you create an issue for an error and only provide a stack trace, it will be closed.
Issues without a response from the original poster will be closed after 6 months.
If an issue has been closed and you still feel it's relevant, feel free to add a comment!
We accept issues in any language. But the maintainers only read English. When an issue is posted in a language besides English, it is acceptable and encouraged to post an English-translated copy as a reply. Anyone may post the translated reply. In most cases, a quick pass through translation software is sufficient. Having the original text as well as the translation can help mitigate translation errors.
Responses to posted issues may or may not be in the original language.
Please note that using non-English as an attempt to circumvent our Code of Conduct will be an immediate, and possibly indefinite, ban from the project.
We welcome Pull Requests to fix or add features. This is a community project and we do not have access to every USB to Serial adapter or every serial device.
- Step 1: Fork this repository
- Step 2: Build it
- Step 3: Make a branch
- Step 4: Make changes and test the changes on actual hardware
- Step 5: Commit the changes to your forked copy of the repository
- Step 6: Rebase to stay in synch
- Step 7: Push your commits to your forked branch
- Step 8: Open the Pull Request
Your Pull Request will need to document the changes and the hardware that it was tested on.
See the DotNet Runtime Coding Style for information about which standards we try to adhere to.