Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more logging messages #15

Open
kneasle opened this issue Nov 20, 2020 · 2 comments
Open

Add more logging messages #15

kneasle opened this issue Nov 20, 2020 · 2 comments
Labels
good first issue Good for newcomers

Comments

@kneasle
Copy link
Owner

kneasle commented Nov 20, 2020

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

@kneasle kneasle added the good first issue Good for newcomers label Nov 20, 2020
@micouy
Copy link

micouy commented Mar 31, 2021

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.

@kneasle
Copy link
Owner Author

kneasle commented Apr 1, 2021

Ok maybe not every function 😅 - 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 😁. 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants