@@ -26,36 +26,36 @@ Thank you for supporting Pynecone!🎊
2626Here is a quick guide to how the run Pynecone repo locally so you can start contributing to the project.
2727
2828First clone Pynecone:
29- ```
29+ ``` bash
3030git clone https://github.com/pynecone-io/pynecone.git
3131```
3232
3333Navigate into the repo:
34- ```
34+ ``` bash
3535cd pynecone
3636```
3737
3838Install poetry and add it to your path (see [ Poetry Docs] ( https://python-poetry.org/docs/#installation ) for more info).
3939
4040Install your local Pynecone build:
41- ```
41+ ``` bash
4242poetry install
4343```
4444
4545Now create an examples folder so you can test the local Python build in this repository:
46- ```
46+ ``` bash
4747mkdir examples
4848cd examples
4949```
5050
5151Create a project in this folder can be named anything but for the sake of the directions we'll use ` example ` :
52- ```
52+ ``` bash
5353mkdir example
5454cd example
5555```
5656
5757Now Init/Run
58- ```
58+ ``` bash
5959poetry run pc init
6060poetry run pc run
6161```
@@ -64,4 +64,25 @@ All the changes you make to the repository will be reflected in your running app
6464* We have the examples folder in the .gitignore, so your changes in pynecone/examples won't be reflected in your commit.
6565
6666
67+ ## ✅ Making a PR
68+
69+ Once you solve a current issue or improvement to Pynecone, you can make a pr, and we will review the changes.
70+
71+ Before submitting, a pull request, ensure the following steps are taken and test passing.
72+
73+ In your ` pynecone ` directory run make sure all the unit tests are still passing using the following command.
74+ ``` bash
75+ poetry run pytest tests
76+ ```
77+ Next make sure all the following tests pass. This ensures that every new change has proper documentation and type checking.
78+ ``` bash
79+ poetry run pyright pynecone tests
80+ poetry run pydocstyle pynecone tests
81+ find pynecone tests -name " *.py" -not -path pynecone/pc.py | xargs poetry run darglint
82+ ```
83+ Finally run ` black ` to format your code.
84+ ``` bash
85+ poetry run black pynecone
86+ ```
87+ That's it you can now submit your pr. Thanks for contributing to Pynecone!
6788
0 commit comments