|
|
@@ -9,19 +9,60 @@ If you encounter a bug or other issue with NiceGUI, the best way to report it is
|
|
|
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.
|
|
|
|
|
|
+## Code of Conduct
|
|
|
+
|
|
|
+We follow a [Code of Conduct](https://github.com/zauberzeug/nicegui/blob/main/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.
|
|
|
+
|
|
|
## Contributing code
|
|
|
|
|
|
If you'd like to contribute code to NiceGUI, we're always looking for bug fixes, performance improvements, and new features.
|
|
|
+
|
|
|
+## Setup
|
|
|
+
|
|
|
+To set up a local development environment for NiceGUI, you'll need to have Python 3 and pip installed. You can then use the following command to install NiceGUI in editable mode:
|
|
|
+
|
|
|
+```bash
|
|
|
+python3 -m pip install -e .
|
|
|
+```
|
|
|
+
|
|
|
+This will install the package and its dependencies, and link it to your local development environment so that changes you make to the code will be immediately reflected.
|
|
|
+Thereby enabling you to use your local version of NiceGUI in other projects.
|
|
|
+
|
|
|
+### Code formatting
|
|
|
+
|
|
|
+We use [autopep8](https://github.com/hhatto/autopep8) with a 120 character line length to format our code.
|
|
|
+Before submitting a pull request, please run
|
|
|
+
|
|
|
+```bash
|
|
|
+autopep8 --max-line-length=120 --experimental --in-place --recursive .
|
|
|
+```
|
|
|
+
|
|
|
+on your code to ensure that it meets our formatting guidelines.
|
|
|
+Alternatively you can use VSCode, open the nicegui.code-workspace file and install the recommended extensions.
|
|
|
+Then the formatting rules are applied whenever you save a file.
|
|
|
+
|
|
|
+## Running tests
|
|
|
+
|
|
|
+Our tests are build with pytest and require python-selenium with Chrome driver.
|
|
|
+
|
|
|
+To run the tests, use the following command:
|
|
|
+
|
|
|
+```bash
|
|
|
+pytest
|
|
|
+
|
|
|
+```
|
|
|
+
|
|
|
+This will run all of the tests in the tests directory.
|
|
|
+Before submitting a pull request, please make sure that all tests are passing.
|
|
|
+
|
|
|
+## Pull requests
|
|
|
+
|
|
|
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/zauberzeug/nicegui/blob/main/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!
|
Rodja Trappe