"Have you found a bug ?" or "Do you want to contribute in making 'natural-cron.js' more flexible ?"
We would definitely like to hear a big "yes" from you. Just make sure to follow the guidelines below, we are eager to see your contribution as a part of this library.
If you have new English phrases that don't work with natural-cron.js
yet, please first discuss the change you wish to make via issue or email (darkeyedev@gmail.com) before making the changes.
-
- Make sure to check if there are any current open issues or pull requests regarding the same change that you want to make.
- Understand how the library works completely and feel free to reach us at darkeyedev@gmail.com for any confusion.
-
- Follow the project directory structure.
- Keep the code well structured, simple & readable as much as possible.
- Follow proper naming conventions for variable & function names.
- Make sure to write comments wherever required (but not too much).
- Remove all debugging comments and log statements (if any) before final commit.
-
-
We use
browserify
to bundle the JS code for browsers.
Install browserify with:npm install -g browserify
Go to
src
folder and run the following command:browserify index.js -d --s getCronString > ../dist/natural-cron.js
(This will prepare the
natural-cron.js
file and put it in/dist
folder) -
We use
JSCompress
for minifying the bundled JS library.
Head to JSCompress and generate minified JS code fromnatural-cron.js
file and put the minified code innatural-cron.min.js
inside the same/dist
folder.
-
-
- If you have worked on some new English phrases, append those example phrases and their outputs in
/test/examples.js
- Open
/test/autoTester.html
file in browser. It will automatically test all the examples in/test/examples.js
file against specified desired outputs for both/dist/natural-cron.js
&/dist/natural-cron.min.js
files - Test & verify that there are no wrong results in the above test & the updates implemented by you work as expected.
- If you have worked on some new English phrases, append those example phrases and their outputs in
-
- Update
README.md
file accordingly (if required).
- Update