Skip to content

Commit 2809184

Browse files
committed
docs: update README.md
1 parent b43d338 commit 2809184

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,13 @@ CLI. For more information on this, please see this [blog post](https://amartin.c
5454
- `jq` (to format JSON output)
5555
- `tidy` (to format HTML output)
5656

57+
> [!NOTE]
58+
>
59+
> 1. Python will be unnecessary once `luarocks.nvim` gets rid of it as a dependency in the `go-away-python` branch.
60+
>
61+
> 2. I will be working on making a binary rock of `Lua-cURL` so that the `cURL` development headers are not
62+
> necessary for the installation process.
63+
5764
### [rocks.nvim](https://github.com/nvim-neorocks/rocks.nvim) (recommended)
5865

5966
```vim
@@ -309,10 +316,16 @@ Here is a preview of the component working :)
309316

310317
1. Fork it (https://github.com/rest-nvim/rest.nvim/fork)
311318
2. Create your feature branch (<kbd>git checkout -b my-new-feature</kbd>)
312-
3. Commit your changes (<kbd>git commit -am 'Add some feature'</kbd>)
313-
4. Push to the branch (<kbd>git push origin my-new-feature</kbd>)
319+
3. Commit your changes (<kbd>git commit -am 'feat: add some feature'</kbd>)
320+
4. Push to the branch (<kbd>git push -u origin my-new-feature</kbd>)
314321
5. Create a new Pull Request
315322

323+
> [!IMPORTANT]
324+
>
325+
> rest.nvim uses [semantic commits](https://www.conventionalcommits.org/en/v1.0.0/) that adhere to
326+
> semantic versioning and these help with automatic releases, please use this type of convention
327+
> when submitting changes to the project.
328+
316329
## Related software
317330

318331
- [vim-rest-console](https://github.com/diepm/vim-rest-console)

0 commit comments

Comments
 (0)