sapling icon indicating copy to clipboard operation
sapling copied to clipboard

Add more logging messages

Open kneasle opened this issue 4 years ago • 2 comments

Ideally, we'd have log::trace! in every function, and log::debug! when debug output might be useful.

kneasle avatar Nov 20 '20 16:11 kneasle

Are you talking about literally every function in the whole crate? I find your project very interesting so I could get to know the project better through this task. Do you have any other advice on how to begin contributing? I've already read ARCHITECTURE.md.

micouy avatar Mar 31 '21 12:03 micouy

Ok maybe not every function :sweat_smile: - I think I was having some trouble debugging something when I made this issue.

To be honest, the point of this is more to encourage new contributors to look round the code (as you noticed) - IMO the place where logging is needed most is the code that handles editing (which currently resides in sapling::editor::Editor).

There currently isn't much contributor advice other than CONTRIBUTING.md/ARCHITECTURE.md and to just get stuck into something :grin:. However, if there is anything that would be useful but doesn't currently exist then please let me know or make a PR for it.

kneasle avatar Apr 01 '21 23:04 kneasle