search

nvim-telescope / telescope.nvim

Find, Filter, Preview, Pick. All lua, all the time.
MIT License
15.98k stars 837 forks source link

FR: mentored projects #1190

Open fdschmidt93 opened 3 years ago

fdschmidt93 commented 3 years ago

Hi all,

since core now engages in mentored projects, I was thinking telescope should maybe follow suit. To that end, here's a list of fixes/features/ideas loosely (and hopefully adequately) sorted from easy to hard the nvim-telescope team is happy to provide guidance on in a PR. Guidance means just open an issue or a first draft PR, lay out how you want to tackle the problem (further) and we'll do our best to help.

Topic Headline Complexity Prelim. Assignee Relevant issues Description
UI dynamic_preview_title truncate on left side Low #1167 dynamic_preview_title needs to be truncatable on the left so the end of the path can be displayed
Feat Composable LSP finders Low-mid #713 Provide action that bridges selected entry and other lsp finders/actions
Feat Picker for lua functions Mid Mentioned on reddit lua fn picker over _G analogous to builtin.commands
UI Highlight match in preview Mid #933 #1042
Feat Picker for tabpages Mid-high Mentioned on gitter Pick and preview tabpages; complexity primarily from previewer
Feat Return values from picker Mid-high #1159 Prior knowledge with (plenary) async recommended
Feat Keep Telescope open High comment Telescope as fuzzy quickfix list? Maybe needs discussion
Feat Combining pickers Very High #213

I'll do my best to keep this list up-to-date.

Here's how you'd start

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b my_contribution)
  3. Make your changes
  4. Stage and commit your Changes (git add -u && git commit -m 'Add my contribution')
  5. Push to the Branch (git push origin my_contribution)
  6. Open a Pull Request by going to the project webpage; it'll then suggest to you to open a PR on telescope

Optionally, you can lay out your solution in the respective issues or a new feature request issue.

TheLeoP commented 3 years ago

Hi.

I would like to start helping with some of this problems, but I'm a CS student and I have barely used github to manage my personal config repo, so I'm very lost about what should I do. I'm not even sure if this is the right place to ask for help about this 😅.

I have watched TJ's video about making a PR to Neovim, though. So I think I have to say I want to help on an issue (#1182 for example), clone the Telescope repo and start working on that (?).

Sorry for all the questions.

fdschmidt93 commented 3 years ago

Sorry for all the questions.

No need to apologize; everybody was starting out at some point!

Here's roughly how you'd start.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b my_contribution)
  3. Make your changes
  4. Stage and commit your Changes (git add -u && git commit -m 'Add my contribution')
  5. Push to the Branch (git push origin my_contribution)
  6. Open a Pull Request by going to the project webpage; it'll then suggest to you to open a PR on telescope

Let me know in case you run into any troubles; I think #1182 hopefully already largely lays out how to tackle the issue, if you have more questions don't hesitate to ping me there!

max397574 commented 2 years ago

I'll try working on the bottom_pane preview width @l-kershaw