-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
Add TODOs Badge to the README #31560
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
Comments
I would like to work on the issue |
I think we would prefer new contributors to use the github issue tracker. TODOs in the codebase are often ill described or outdated or of a unknown difficulty. That said its actually interesting to see them all on one page. So i'm fine either with this. Just don't think we should point new contributors to it :) |
Sure
Thank you for taking the time to respond.
…On Sun, 2 Feb 2020 at 8:43 PM, alimcmaster1 ***@***.***> wrote:
It can help surface latent work and be a way for new contributors to find
areas of code to improve.
I think we would prefer new contributors to use the github issue tracker.
TODOs in the codebase are often ill described or outdated or of a unknown
difficulty.
That said its actually interesting to see them all on one page. So i'm
fine either with this. Just don't think we should point new contributors to
it :)
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#31560?email_source=notifications&email_token=AKKXRKKLAQWLT2FINMDKNSLRA3PH3A5CNFSM4KOXOZ62YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEKRZCQA#issuecomment-581144896>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AKKXRKLT3GN7AIPC4AJKPATRA3PH3ANCNFSM4KOXOZ6Q>
.
|
I agree with @alimcmaster1, I also wouldn't point new contributors to that (our TODO's are not always up to date, often lack information for newcomers to understand, etc), so I would rather not add it to the readme then. |
That makes sense to me. I think TODO comments can often be a precursor to a proper ticket/issue rather than equivalent to one. FYI a feature coming soon is a button to link directly to github issue creation from a TODO that's been indexed. I think generally, it's useful to surface TODOs as a means of not letting too many get lost (either by just displaying and aggregating them or by making it easier to produce tickets/issues from them). |
Do let us know when that feature is available @patrickdevivo. Il close this for now but feel free to reopen. Maybe @jbrockmendel would fine this handy? https://todos.tickgit.com/browse?repo=github.com/pandas-dev/pandas |
I just wanted to circle back here with some updates! The new view I mentioned has been launched: https://www.tickgit.com/browse?repo=github.com/pandas-dev/pandas with a card layout that should hopefully be clearer to read than the previous table layout. Cards also include a button to make a Github issue directly from a TODO. Pretty soon there will be more advanced filtering options as well, allowing users to lookup only TODOs they've created, within a time range, or within a particular directory. I hope the project remains interesting! If there's any desire to add a badge to this repo, I'd be happy to open a PR. Thanks so much |
Hi there! I wanted to propose adding the following badge to the README to indicate how many
// TODO
comments are in this codebase:The badge links to
tickgit.com
which is a free service that indexes and displays TODO comments in public github repos. It can help surface latent work and be a way for new contributors to find areas of code to improve.The markdown is:
Thanks for considering, feel free to close this issue if it's not appropriate or you prefer not to!
The text was updated successfully, but these errors were encountered: