Skip to content

Commit 7f7ec04

Browse files
committed
Added section on preparing for PRs, and supporting holroy
Clarified some steps related to preparing for a Pull request, and a little information related to supporting the contributors.
1 parent 1d0fc20 commit 7f7ec04

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

Diff for: README.md

+17
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,19 @@ This will install libraries, build dataview, and deploy it to `test-vault`, whic
162162
will also put `rollup` in watch mode, so any changes to the code will be re-compiled and the test vault will automatically
163163
reload itself.
164164

165+
#### Preparing for creating pull requests
166+
167+
If you plan on doing pull request, we would also recommend to do the following in advance of creating the pull request:
168+
169+
```console
170+
foo@bar:~$ npm run dev
171+
foo@bar:~$ npm run check-format
172+
foo@bar:~$ npm run format
173+
foo@bar:~$ npm run test
174+
```
175+
176+
The third step of `npm run format` is only needed if the format check reports some issue.
177+
165178
#### Installing to Other Vaults
166179

167180
If you want to dogfood dataview in your real vault, you can build and install manually. Dataview is predominantly a
@@ -197,4 +210,8 @@ Have you found the Dataview plugin helpful, and want to support it? I accept don
197210
development efforts. I generally do not accept payment for bug bounties/feature requests, as financial incentives add
198211
stress/expectations which I want to avoid for a hobby project!
199212

213+
Support @blacksmithgu:
200214
[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/donate?business=Y9SKV24R5A8BQ&item_name=Open+source+software+development&currency_code=USD)
215+
216+
Support @holroy:
217+
<a href="https://www.buymeacoffee.com/holroy" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 40px !important;width: 175px !important;" ></a>

0 commit comments

Comments
 (0)