Skip to content

Commit 5d3ecad

Browse files
authored
Added steps to make a pr. (#286)
1 parent b93c7a8 commit 5d3ecad

File tree

1 file changed

+27
-6
lines changed

1 file changed

+27
-6
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,36 +26,36 @@ Thank you for supporting Pynecone!🎊
2626
Here is a quick guide to how the run Pynecone repo locally so you can start contributing to the project.
2727

2828
First clone Pynecone:
29-
```
29+
``` bash
3030
git clone https://github.com/pynecone-io/pynecone.git
3131
```
3232

3333
Navigate into the repo:
34-
```
34+
``` bash
3535
cd pynecone
3636
```
3737

3838
Install poetry and add it to your path (see [Poetry Docs](https://python-poetry.org/docs/#installation) for more info).
3939

4040
Install your local Pynecone build:
41-
```
41+
``` bash
4242
poetry install
4343
```
4444

4545
Now create an examples folder so you can test the local Python build in this repository:
46-
```
46+
``` bash
4747
mkdir examples
4848
cd examples
4949
```
5050

5151
Create a project in this folder can be named anything but for the sake of the directions we'll use `example`:
52-
```
52+
``` bash
5353
mkdir example
5454
cd example
5555
```
5656

5757
Now Init/Run
58-
```
58+
``` bash
5959
poetry run pc init
6060
poetry 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

Comments
 (0)