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

Thank you and a little suggestion on docs #2

Open
lqu opened this issue Dec 14, 2023 · 0 comments
Open

Thank you and a little suggestion on docs #2

lqu opened this issue Dec 14, 2023 · 0 comments

Comments

@lqu
Copy link

lqu commented Dec 14, 2023

Thank you for sharing your great work and fun ideas! I like your way of documentation, examples, especially the copyright/license notice. I wonder if you can add more to the docs, such as the following.

  • preconditions
    • does the calendar have to be blank?
    • does it depend on a certain version of GitHub environment?
  • side effects
    • does running this app clear the existing calendar?
  • idempotence
    • what happens if it's run twice with different input?

I know I can get the answers from reading the source code, and all should do that before they run any scripts downloaded from the internet. But there is a difference between the current behavior and your design goals.

Cheers,
lqu

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

No branches or pull requests

1 participant