|
|
@@ -0,0 +1,28 @@
|
|
|
+# Contributing to NiceGUI
|
|
|
+
|
|
|
+We're thrilled that you're interested in contributing to NiceGUI!
|
|
|
+Here are some guidelines that will help you get started.
|
|
|
+
|
|
|
+## Reporting issues
|
|
|
+
|
|
|
+If you encounter a bug or other issue with NiceGUI, the best way to report it is by opening a new issue on our [GitHub repository](https://github.com/nicegui/nicegui).
|
|
|
+When creating the issue, please provide a clear and concise description of the problem, including any relevant error messages and code snippets.
|
|
|
+If possible, include steps to reproduce the issue.
|
|
|
+
|
|
|
+## Contributing code
|
|
|
+
|
|
|
+If you'd like to contribute code to NiceGUI, we're always looking for bug fixes, performance improvements, and new features.
|
|
|
+To get started, fork the repository on GitHub, make your changes, and open a pull request (PR) with a detailed description of the changes you've made.
|
|
|
+
|
|
|
+When submitting a PR, please make sure that the code follows the existing coding style and that all tests are passing.
|
|
|
+If you're adding a new feature, please include tests that cover the new functionality.
|
|
|
+
|
|
|
+## Code of Conduct
|
|
|
+
|
|
|
+We follow a [Code of Conduct](https://github.com/nicegui/nicegui/blob/master/CODE_OF_CONDUCT.md) to ensure that everyone who participates in the NiceGUI community feels welcome and safe.
|
|
|
+By participating, you agree to abide by its terms.
|
|
|
+
|
|
|
+## Thank you!
|
|
|
+
|
|
|
+Thank you for your interest in contributing to NiceGUI!
|
|
|
+We're looking forward to working with you!
|
Rodja Trappe