nvim-plugins/telescope.nvim
1
0
Fork 0
mirror of https://github.com/nvim-telescope/telescope.nvim synced 2024-09-08 01:15:42 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs(contrib): update contribution guide (#2879)

Browse source
This commit is contained in:
James Trew 2024-01-21 17:07:28 -05:00 committed by GitHub
parent 0902bb39eb
commit 20efb38649
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 15 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
CONTRIBUTING.md
View file

@ -2,8 +2,19 @@
Thanks for taking the time to submit code to Telescope if you're reading this!
We love having new contributors and love seeing the Neovim community come around this plugin and keep making it better.
Currently, our focus is on maintaining the robustness and reliability of existing features, which means we are prioritizing bug fixes and improvements to what's already here.
If you're submitting a new feature, please be aware that while we appreciate your effort, our capacity to integrate and maintain new features is limited at this time.
At this time, we are content with the number and functionality of the pickers we offer built
in with Telescope and so we are currently not accepting new pickers
(see this [issue](https://github.com/nvim-telescope/telescope.nvim/issues/1228) for a discussion on this).
We are also conservative with integrating picker specific actions and features.
If you're still interested in filling a particular picker need, we encourage packaging it up as its own Telescope extension.
Read our [Bundling as extension](https://github.com/nvim-telescope/telescope.nvim/blob/master/developers.md#bundling-as-extension) guide here for more info on this.
See other Telescope extensions (and add yours) [here](https://github.com/nvim-telescope/telescope.nvim/wiki/Extensions).
That said, we welcome bug fixes, documentation improvements and non-picker specific features.
If you're submitting a new feature, it is a good idea to create an issue first to gauge interest and feasibility.
To learn how we go about writing documentation for this project, keep reading below!
## Documentation with treesitter
@ -39,7 +50,7 @@ This guide contains all annotations and we will update it when we add new annota
## What is missing?
The docgen has some problems on which people can work. This would happen in [https://github.com/tjdevries/tree-sitter-lua](https://github.com/tjdevries/tree-sitter-lua) and documentation of some modules here.
The docgen has some problems on which people can work. This would happen in [tree-sitter-lua](https://github.com/tjdevries/tree-sitter-lua) and documentation of some modules here.
I would suggest we are documenting lua/telescope/builtin/init.lua rather than the files itself. We can use that init.lua file as "header" file, so we are not cluttering the other files.
How to help out with documentation:
@ -55,7 +66,7 @@ The easy way would be:
## Generate on your local machine
The other option would be setting up https://github.com/tjdevries/tree-sitter-lua
The other option would be setting up <https://github.com/tjdevries/tree-sitter-lua>
- Install Treesitter, either with package manager or with github release
- Install plugin as usual