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

Provide an example of the timesheet that would be generated and what token is supposed #3

Open
yedhink opened this issue Feb 23, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@yedhink
Copy link

yedhink commented Feb 23, 2023

@vivekmiyani

Thanks for taking the time to create this tool. Few suggestions:

  • Would be great if there's an example of the timesheet that would be generated
  • Provide reference to the example projects YAML using Markdown links - a bit of handholding is ok.
  • Point out what exactly is your_token and how exactly one could get it - I am not sure whether it would be obvious for everyone on what this token is - explicitly mentioning how to generate PAT
  • Not just that, explicitly point out the scope of the token - like I think this script only needs to read the commit history(not sure though) - so only such permissions ought to be given when generating the token - that should be mentioned in the README.
@vivekmiyani vivekmiyani added the documentation Improvements or additions to documentation label Feb 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants