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

Change how internal console messages are written #1886

Closed
geoff-harper opened this issue Sep 21, 2020 · 6 comments · May be fixed by #1925
Closed

Change how internal console messages are written #1886

geoff-harper opened this issue Sep 21, 2020 · 6 comments · May be fixed by #1925

Comments

@geoff-harper
Copy link

Please change your console messages to info or debug instead of log so they can be disabled easily. Playing "spot the actually useful log I wrote for myself" in a sea of Openseadragon spam isn't a fun dev experience. Of course I could filter them every time I open the dev tools but why? It also spams remote analytics tools which requires extra filtering etc.

Annotation 2020-09-21 141817

@geoff-harper geoff-harper changed the title Change change how internal console messages are written Change how internal console messages are written Sep 21, 2020
@iangilman
Copy link
Member

Good point! Someone should go through and audit which things should be what level. We already have a number of console.error, console.warn, and console.assert that should stay as is. Probably anything that's console.log should either become console.error (where it's an error message), console.info (if it's still worthwhile information), or removed/commented out (if it's entirely unnecessary).

You're welcome to make a pull request to that effect if you'd like. If not, hopefully someone else will pick this up.

@Abhishek-90
Copy link
Contributor

Hi @iangilman, I am new to open source. I would like to start by contributing to this issue. Can you help me understand it completely or any guidance on how I can solve this would be really great and helpful.

@iangilman
Copy link
Member

@Abhishek-90 welcome! This is a wonderful issue to work on :)

My recommendation is to search the src folder for console.log and look at all the ones that aren't commented out (if they are commented out we don't need to worry about them). If they are logging an error, change them to console.error and if they are just logging some information, change them to console.info.

Don't change any of the logging in the test folder; those are all fine.

If you need info about making a pull request, check out https://github.com/openseadragon/openseadragon/wiki/Making-a-Pull-Request

Thank you!

@Abhishek-90
Copy link
Contributor

@iangilman thankyou very much. I will get to it now.

@bonysureliya
Copy link

Hi @iangilman , I want to contribute to issue can you help me further

@iangilman
Copy link
Member

@bonysureliya Great! It looks like this issue is actually fixed (by #2073), so I'll close it. There are a number of other issues you can start with:

good first issue

Just pick one and get started! Let me know if you have questions. Here's more info on contributing:

https://github.com/openseadragon/openseadragon/blob/master/CONTRIBUTING.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants