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 a time method #172

Merged
merged 6 commits into from
Nov 14, 2021
Merged

Add a time method #172

merged 6 commits into from
Nov 14, 2021

Conversation

sergeysova
Copy link
Member

@sergeysova sergeysova commented Oct 9, 2021

I'm going to add docs and type tests after a code review

Checklist for a new method

  • Create a directory for the new method in the src directory in param-case
  • Place the source code to src/method-name/index.ts in ESModules export in camelCase named export
  • Add tests to src/method-name/method-name.test.ts
  • Add fork tests to src/method-name/method-name.fork.test.ts
  • Add type tests to test-typings/method-name.ts
    • Use // @ts-expect-error to mark expected type error
    • import { expectType } from 'tsd' to check expected return type
  • Add documentation in src/method-name/reade.md
    • Add header Patronum/MethodName
    • Add section with overloads, if have
    • Add Motivation, Formulae, Arguments and Return sections for each overload
    • Add useful examples in Example section for each overload
  • Add section to README.md in the repository root
    • Add method to the table of contents into correct category - [MethodName](#methodname) - description.
    • Add section ## MethodName
    • Add [Method documentation & API](/src/method-name) into section
    • Add simple example

closes #152

@sergeysova sergeysova marked this pull request as ready for review October 9, 2021 21:33
@sergeysova sergeysova added the feature New functionality label Oct 9, 2021
Copy link
Member

@igorkamyshev igorkamyshev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sonds great

@igorkamyshev
Copy link
Member

@sergeysova any updates here? Maybe I can help you somehow?

@sergeysova
Copy link
Member Author

@igorkamyshev Need a documentation and type tests.

@sergeysova sergeysova mentioned this pull request Nov 14, 2021
35 tasks
@sergeysova sergeysova self-assigned this Nov 14, 2021
@sergeysova sergeysova merged commit 53e660a into main Nov 14, 2021
@sergeysova sergeysova deleted the create-time-method branch November 14, 2021 18:27
@sergeysova sergeysova added this to the v2.0 milestone Feb 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add currentTime operator
3 participants