Help is always welcome. There are areas where you can help:
-
The core functionality (performance improvements, bug fixes, new features, etc.).
-
Documentation (markdown documents, inline JSDoc comments).
-
Test suite & development environment improvements.
-
The website.
If you see a gap, but don't have time, experience, or you just need help with the library, don't hesitate to shoot an issue.
The date-fns functionality is comprehensive and covers most of the use cases, however it doesn't have extended time zone support. Please leave a comment to the Extended time zones support issue if you are interested in the functionality or want to help with development.
If you are interested in Elm/ClojureScript/etc. wrappers, please file an issue.
Due to the modular nature of date-fns, it's more than open to new features. However, when a new function duplicates the existing functionality, native API or causes significant build size increase, a PR might be rejected or the author can be asked to move the code to a new or another package.
Please follow the main contributing rules, to maintain date-fns' top quality:
-
Follow style guides:
-
Write tests.
-
Add an entry to Unreleased section in CHANGELOG.
-
Squash related commits before a PR merge.
-
Don't change the library version.
-
Fork the project and clone the fork repo.
-
Run
npm installto install the application dependencies
The project follows JavaScript Standard Style. To lint the code, run:
npm run lintThe project uses EditorConfig to define basic coding style guides. Please install a plugin for your editor of choice or manually enforce the rules listed in .editorconfig.
JSDoc is used for the code documentation. Along with
standard JSDoc tags, date-fns uses @category tag that allows
to group functions.
jsdoc-parse is used to generate documentation JSON consumed by date-fns.org.