Skip to content

Commit d09d73c

Browse files
authored
Reference issues for improvements in README, and improve contributing tips
1 parent e297817 commit d09d73c

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -79,19 +79,20 @@ Combine these together! This opens each matching note in your `$EDITOR` in turn.
7979

8080
All the above works. Here's what's coming next:
8181

82-
- [ ] Combining find and grep, to match either one
83-
- [ ] More interesting and nicer looking file/grep search result formatting (...only when not piping?)
84-
- [ ] Make the file extension optional
85-
- [ ] zsh command autocompletion
86-
- [ ] zsh note name autocompletion
87-
- [ ] Interactive mode? `notes` could open a scrollable list of notes, open your editor when you pick one, and reappear after you close it.
88-
- [ ] Tree view.
89-
- [ ] Easy way to see short notes snippets in find/grep/tree? Could be option (`--snippets`) or by piping to a command (`notes find | notes snippets`). Maybe call it `head`?
90-
- [ ] Version control - probably by finding an easy (optional) way to integrate this automatically with Git.
82+
- [ ] Combining find and grep, to match either one (https://github.com/pimterry/notes/issues/16)
83+
- [ ] More interesting and nicer looking file/grep search result formatting, perhaps only when not piping? (https://github.com/pimterry/notes/issues/27)
84+
- [ ] Make the file extension optional (https://github.com/pimterry/notes/issues/24)
85+
- [ ] zsh command and note name autocompletion (https://github.com/pimterry/notes/issues/25)
86+
- [ ] Interactive mode? `notes` could open a scrollable list of notes, open your editor when you pick one, and reappear after you close it. (https://github.com/pimterry/notes/issues/17)
87+
- [ ] Tree view (https://github.com/pimterry/notes/issues/26)
88+
- [ ] Easy way to see short notes snippets in find/grep/tree? Could be option (`--snippets`) or by piping to a command (`notes find | notes snippets`). Maybe call it `head`? (https://github.com/pimterry/notes/issues/22)
89+
- [ ] Version control - probably by finding an easy (optional) way to integrate this automatically with Git (https://github.com/pimterry/notes/issues/12)
9190

9291
## I want to help
9392

94-
Great! Jump in. Feel free to play around, open an issue with new feature ideas or open PRs for fixes (although check with an issue first if you want to do anything substantial).
93+
Great! Jump in. Feel free to play around, open an issue with new feature ideas or open PRs for fixes and improvements. Do check with an issue first if you're planning to do anything substantial to avoid disappointment.
94+
95+
Remember that `notes` is intended to be a small toolbox of commands - if it's possible to build your extension as an independent wrapper building on the existing notes commands, that's probably a better first step. Create new functionality on top of `notes` and then file issues to extend `notes` to better support that wrapper, or to merge your wrapper in as a built-in command later, once you're sure it works and it's useful.
9596

9697
If you want to get the code locally you'll need to:
9798

@@ -101,8 +102,10 @@ git submodule update --init --recursive
101102
./test.sh # Check the tests work before you make any changes
102103
```
103104

105+
If you install [`entr`](http://entrproject.org/) you can also run `./dev.sh`, which will watch all files within the project directory, and rerun tests any time they change.
106+
104107
If you submit a PR, please make sure it:
105108

106-
* Doesn't break existing tests
109+
* Doesn't break any existing tests
107110
* Adds new tests, if appropriate
108111
* Adds new documentation, if appropriate

0 commit comments

Comments
 (0)