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

Full repo review #15

Closed
wants to merge 223 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
223 commits
Select commit Hold shift + click to select a range
56ec673
Update README.md
Hexagon Dec 9, 2015
cc9495e
Update README.md
Hexagon Dec 9, 2015
3c2b565
Adding the actual files
Hexagon Dec 9, 2015
aa6a969
Minor fixes
Hexagon Dec 9, 2015
01b20a1
Trying to fix build for 0.12
Hexagon Dec 9, 2015
78cf5bc
Remove support for 0.12 for now
Hexagon Dec 9, 2015
56933b7
Fixed readme
Hexagon Dec 9, 2015
cbf82c0
Update README.md
Hexagon Dec 9, 2015
f2880f3
Version bump
Hexagon Dec 9, 2015
2e5bba1
Added scheduler functionality
Hexagon Dec 10, 2015
5475d26
Documentation, cleanup, version bump
Hexagon Dec 10, 2015
626d35a
Bugfix for maxRuns
Hexagon Dec 10, 2015
3dda7ef
Fix for setTimeout max ms == 0x7FFFFFFF
Hexagon Dec 10, 2015
f8dd895
oops
Hexagon Dec 10, 2015
29a7a0c
Quick runthrough (fixes)
unkelpehr Dec 10, 2015
01caeeb
Add pause and resume, change kill to stop
Hexagon Dec 11, 2015
de7c34a
Update croner.js
Hexagon Dec 15, 2015
d1f127b
Update croner.js
Hexagon Dec 15, 2015
9c183d7
More test cases, removed crap, bump version
Hexagon Jan 4, 2016
ab76430
Merge remote-tracking branch 'origin/master'
Hexagon Jan 4, 2016
7eaddc2
Added test for omitted `new` keyword
Hexagon Jan 4, 2016
593221d
Bumped version, again
Hexagon Jan 4, 2016
92cce59
Oops
Hexagon Jan 4, 2016
1aed9e6
Added build target for Node 0.12 and 4.2
Hexagon Jan 4, 2016
682aca7
Oops, again
Hexagon Jan 4, 2016
6f951b9
Added polyfill for Array.fill, bump version
Hexagon Jan 4, 2016
f7cf0b5
Fix, version bump
Hexagon Jan 28, 2016
0edb49f
Fixed double runs
Hexagon Jan 28, 2016
0068719
Linting
Hexagon Feb 1, 2016
64da37b
Linting
Hexagon Feb 2, 2016
6b49865
Linting
Hexagon Feb 3, 2016
c166b9f
Simplification, linting
Hexagon Feb 4, 2016
adffc09
KISS + Linting
Hexagon Feb 7, 2016
4a4c4de
msToNext bugfix, test coverage, version bump
Hexagon Feb 7, 2016
3daa63a
Update README.md
Hexagon Feb 7, 2016
e1debed
Added minified version + tests
Hexagon Feb 7, 2016
04128cb
msToNext/schedule bugfix, version bump
Hexagon Feb 7, 2016
49a2a83
Cleanup, Docmntn, cron -> Cron, minor version bump
Hexagon Feb 7, 2016
a047138
Update README.md
Hexagon Feb 7, 2016
70a54a1
Update package.json
Hexagon Feb 7, 2016
43a12ed
Minor lint
Hexagon Feb 7, 2016
39e70f1
Added stepping (*/5), tests, documentation and version bump.
Hexagon Sep 26, 2016
e61c61b
Text fix, minified, version bump
Hexagon Sep 26, 2016
29443aa
Additional build targets (node 5.11, 6.1)
Hexagon Sep 26, 2016
442f2e3
Linting, minor typo, version bump
Hexagon Sep 26, 2016
6120fb1
Minor cleanup
Hexagon Sep 27, 2016
9564fb4
startAt, stopAt fix in croner. DST fix in test.
Hexagon Oct 23, 2016
5fc1a71
Hotfix startAt/stopAt
Hexagon Oct 23, 2016
deb69aa
Minor fixes
Hexagon Oct 26, 2016
a9ddec1
Minor fixes
Hexagon Oct 26, 2016
0a05b6c
Minor fixes
Hexagon Oct 29, 2016
05b3a14
Added cdn
Hexagon Nov 8, 2016
4788b9f
Fix for passed startAt, release 1.1.13
Hexagon Nov 11, 2016
28fa49c
Code style, minor fix, release 1.1.14
Hexagon Nov 12, 2016
7dedd2e
Update README.md
Hexagon Nov 12, 2016
148dcb5
Documentation, release 1.1.15
Hexagon Nov 17, 2016
af01bfc
Typos
Hexagon Nov 17, 2016
18e1fb9
Minor fix
Hexagon Nov 24, 2016
faeff0a
Bugfix, release 1.1.17
Hexagon Nov 28, 2016
e0e4c6c
Minor fixes
Hexagon Mar 21, 2017
ee3a229
Typo
Hexagon Mar 21, 2017
d3b713d
Release 1.1.20
Hexagon Sep 15, 2017
13bb161
Release 1.1.21, further improvements
Hexagon Sep 21, 2017
f6cdca0
Maintenance, release 1.1.22
Hexagon Nov 20, 2019
5371023
Maintenance, release 1.1.23
Hexagon Nov 20, 2019
3d4b14f
Update README.md
Hexagon Oct 2, 2021
382b35e
Update NPM-scripts, add eslint av dev-dependency, run eslint on test.
Hexagon Oct 3, 2021
1e66a81
Proper ESM support
Hexagon Oct 3, 2021
bb857a9
Bump to 1.1.24
Hexagon Oct 3, 2021
6b59cc4
ESM fix
Hexagon Oct 3, 2021
9d50cb8
Another ESM-fix
Hexagon Oct 3, 2021
5b0877b
ESM fix
Hexagon Oct 4, 2021
72da51d
Fix build
Hexagon Oct 4, 2021
4cabdb4
Remove Node 8 from automated testing
Hexagon Oct 4, 2021
7ee900d
Remove Node 10 from automated testing
Hexagon Oct 4, 2021
03016a9
Update README.md
Hexagon Oct 4, 2021
22bb19d
Documentation update, bump to 1.1.28
Hexagon Oct 4, 2021
fe8b04e
Add JSDoc and generated TypeScript typing definitions.
Hexagon Oct 5, 2021
b97c24f
Bump webpack dev dependency.
Hexagon Oct 5, 2021
dfe99d1
Add .previous(), fix millisecond issue, change typescript export defi…
Hexagon Oct 6, 2021
e17da7b
Documentation update
Hexagon Oct 6, 2021
16884de
Documentation update
Hexagon Oct 6, 2021
675c76b
Fix
Hexagon Oct 6, 2021
d078f78
UMD fix
Hexagon Oct 6, 2021
589ad76
2.0
Hexagon Oct 7, 2021
d88014b
TypeScript fix
Hexagon Oct 7, 2021
3c01aaf
Documentation fix
Hexagon Oct 7, 2021
7e6277a
Documentation fix
Hexagon Oct 7, 2021
45baee0
Lint run
Hexagon Oct 7, 2021
93e55d3
3.0, switch to type=module
Hexagon Oct 8, 2021
a9a9eb7
3.0, switch to type=module
Hexagon Oct 8, 2021
9874e12
TypeScript fix
Hexagon Oct 8, 2021
c7b175b
Make seconds optional
Hexagon Oct 8, 2021
2490f4b
Fix startAt
Hexagon Oct 8, 2021
602c5b6
Stricter types, cleanup, bump to 3.0.42.
Hexagon Oct 10, 2021
e243d56
Cleanup + fix of typedef for options
Hexagon Oct 10, 2021
c2d8946
Documentation fix
Hexagon Oct 10, 2021
09fae41
Experimental timezone support, bump 3.0.43
Hexagon Oct 10, 2021
4ae94e7
Options passed without reason
Hexagon Oct 10, 2021
6073249
Changes
Hexagon Oct 11, 2021
c108601
Bump
Hexagon Oct 11, 2021
47b5ab0
Fix for stop/resume/pause
Hexagon Oct 11, 2021
a903535
More fixes
Hexagon Oct 11, 2021
76d5bcd
Fix typings
Hexagon Oct 11, 2021
b883caf
More typing fixes
Hexagon Oct 11, 2021
17ca090
Another Typing fix, bump 3.0.49
Hexagon Oct 12, 2021
79687d4
Recursion fix, bump 3.0.50
Hexagon Oct 12, 2021
6b35f3f
Documentation update
Hexagon Oct 12, 2021
05dd4ce
Documentation update
Hexagon Oct 12, 2021
adab086
Bump
Hexagon Oct 12, 2021
ecccec1
Documentation update
Hexagon Oct 12, 2021
fae3e1b
Documentation update
Hexagon Oct 12, 2021
03ddbab
Update README.md
Hexagon Oct 12, 2021
707ddac
Lots of fixes, major bump to 4.0.52
Hexagon Oct 14, 2021
6439b72
Fix automated build
Hexagon Oct 14, 2021
2f64c77
Fix
Hexagon Oct 14, 2021
9d29582
Fix
Hexagon Oct 14, 2021
0f2b28a
Code cleanup
Hexagon Oct 15, 2021
f35dea5
Documentation update
Hexagon Oct 15, 2021
96afadb
Documentation update
Hexagon Oct 15, 2021
cdd5f3b
Code cleanup, add SUN-SAT, JAN-DEC
Hexagon Oct 16, 2021
79b4b76
Documentation update
Hexagon Oct 16, 2021
04f77aa
Documentation update
Hexagon Oct 16, 2021
cf15f55
Documentation update
Hexagon Oct 16, 2021
71a870f
Documentation update
Hexagon Oct 16, 2021
eef39f8
Create FUNDING.yml
Hexagon Oct 17, 2021
f167844
Reenable time zone tests
Hexagon Oct 17, 2021
a3ce56a
Merge branch 'master' of https://github.com/Hexagon/croner
Hexagon Oct 17, 2021
cdcf160
Tests pass in CI?
Hexagon Oct 17, 2021
fceff26
Tests pass in CI?
Hexagon Oct 17, 2021
7720adf
Need to specify timezone when testing exakt millisecond time.
Hexagon Oct 17, 2021
d216411
Fix test
Hexagon Oct 17, 2021
df8dbc3
Time zone fix. Bump to 4.0.55
Hexagon Oct 17, 2021
f977a6b
Time zone fixes, doc improvements.
Hexagon Oct 17, 2021
ea0b214
Update README.md
Hexagon Oct 17, 2021
5ff1c5d
Bump to 4.0.56
Hexagon Oct 17, 2021
2485f48
Minor fixes, bump to 4.0.57
Hexagon Oct 18, 2021
1ef27c1
Build dist
Hexagon Oct 18, 2021
06584c3
Create codeql-analysis.yml
Hexagon Oct 19, 2021
acdd1d4
Create SECURITY.md
Hexagon Oct 19, 2021
64bb3d8
Create node.js.yml
Hexagon Oct 19, 2021
7eeaffc
Add package-lock.json for GitHub CI
Hexagon Oct 19, 2021
5c68b14
Merge branch 'master' of https://github.com/Hexagon/croner
Hexagon Oct 19, 2021
d3fc32e
Update node.js.yml
Hexagon Oct 20, 2021
a735de9
Replace Travis CI with Node.js CI
Hexagon Oct 20, 2021
2b426e5
Logo
Hexagon Oct 20, 2021
1ad4bc3
Bump
Hexagon Oct 20, 2021
9f24625
Automatic NPM publish
Hexagon Oct 20, 2021
18e8f0e
Merge branch 'master' of https://github.com/Hexagon/croner
Hexagon Oct 20, 2021
e4d3be0
Bump
Hexagon Oct 20, 2021
c5c8827
Limit files in distributed packages.
Hexagon Oct 20, 2021
fe41d79
TS Fix: Return type for .previous()
Hexagon Oct 20, 2021
ddcec12
Update README.md
Hexagon Oct 21, 2021
0eacecf
Update README.md
Hexagon Oct 21, 2021
da7e8d6
Update README.md
Hexagon Oct 21, 2021
5e3c3d7
Update package.json
Hexagon Oct 21, 2021
ddf8af6
Replaced mocha and should with uvu
Hexagon Oct 24, 2021
6f6064e
Merge branch 'master' of https://github.com/Hexagon/croner
Hexagon Oct 24, 2021
06be660
Bump
Hexagon Oct 24, 2021
cbbdb3c
Replace webpack with rollup, bump to 4.0.63
Hexagon Oct 25, 2021
da821f8
Added pre build cleanup task.
Hexagon Oct 25, 2021
7cedef7
Compressed logo
Hexagon Oct 25, 2021
2959ada
Documentation and (dev)dependency update.
Hexagon Oct 27, 2021
83baf3a
Typos
Hexagon Oct 27, 2021
4fcfb7b
Doc improvements
Hexagon Oct 27, 2021
85cf24d
Automatic GH-Pages
Hexagon Oct 27, 2021
67d8db9
Minor fixes, bump to 4.0.66
Hexagon Oct 28, 2021
c31e447
Update docs
Hexagon Oct 28, 2021
d73888b
Documentation note
Hexagon Oct 28, 2021
df603d4
Doc update
Hexagon Oct 28, 2021
faa6136
Update README.md
Hexagon Oct 28, 2021
8760f72
DST bugfix + docs
Hexagon Oct 29, 2021
3af7c78
Merge branch 'master' of https://github.com/Hexagon/croner
Hexagon Oct 29, 2021
1683a09
Documentation update
Hexagon Oct 30, 2021
a8e3698
Maintenance
Hexagon Nov 6, 2021
d795a1d
Fix build
Hexagon Nov 6, 2021
4fc95d3
Create dependabot.yml
Hexagon Nov 7, 2021
f863b2f
Add dependency checks to local build pipeline, do not run on ci builds.
Hexagon Nov 7, 2021
787dc67
Merge branch 'master' of https://github.com/Hexagon/croner
Hexagon Nov 7, 2021
2afe799
Move to luxon
Hexagon Nov 10, 2021
1ea5117
Bundle luxon
Hexagon Nov 10, 2021
a58a9cf
Revert "Bundle luxon"
Hexagon Nov 10, 2021
e923821
Revert "Move to luxon"
Hexagon Nov 10, 2021
e22ee02
Cleanup/fixes
Hexagon Nov 10, 2021
aee00f5
Update package.json
Hexagon Nov 11, 2021
66b5b55
Deno support + typescript fix.
Hexagon Nov 11, 2021
0186b00
No need for mod.ts
Hexagon Nov 11, 2021
4583567
Remove unused files
Hexagon Nov 11, 2021
49d2cb0
Minor doc fix
Hexagon Nov 11, 2021
0b7676e
Add new option 'catch', default value false.
Hexagon Nov 13, 2021
85b2171
Update docs
Hexagon Nov 13, 2021
6f5903c
TS/Deno documentation fix.
Hexagon Nov 13, 2021
f1150ff
Node.JS/Typescript fix
Hexagon Nov 19, 2021
227e975
Feature: Combine range with steps
Hexagon Nov 19, 2021
9b609f5
Minor doc fix
Hexagon Nov 19, 2021
a48a50c
Update README.md
Hexagon Nov 20, 2021
7e6fe3a
Update README.md
Hexagon Nov 20, 2021
d7ad225
Update README.md
Hexagon Nov 20, 2021
f413d52
Feature: Combine range with steps
gilles-crealp Nov 22, 2021
02105f2
Merge pull request #10 from gilles-crealp/master
Hexagon Nov 22, 2021
2a3fc53
Wrong error handling
gilles-crealp Nov 22, 2021
85ac575
Merge pull request #11 from gilles-crealp/master
Hexagon Nov 22, 2021
62c0289
Cleanup of old range-with-stepping, and tests for new.
Hexagon Nov 22, 2021
84f5f7f
Update README.md
Hexagon Nov 22, 2021
cf67815
Update README.md
Hexagon Nov 22, 2021
8502667
Cleanup (remove 'self' + fix constness)
Hexagon Nov 23, 2021
5d3ab45
Create CONTRIBUTING.md
Hexagon Nov 23, 2021
606ee63
Grammar check: fixed small typo, more signs to keep it consistent and…
enzom-uy Nov 23, 2021
83364dd
Merge pull request #14 from enzomdev/enzomdev-readme-grammar
Hexagon Nov 23, 2021
5cd4a02
Updated docs (hexagon.github.io/croner)
Hexagon Nov 23, 2021
d5941ca
Update README.md
Hexagon Nov 23, 2021
ead9839
Updated contribution guide + Feature: Pass context
Hexagon Nov 25, 2021
047ae5e
Update CONTRIBUTING.md
Hexagon Nov 25, 2021
2cbbfbd
Update documentation
Hexagon Nov 25, 2021
54ee672
Oops, version...
Hexagon Nov 25, 2021
dcfecd2
Update CONTRIBUTING.md
Hexagon Nov 25, 2021
0deab18
Update README.md
Hexagon Nov 26, 2021
6c28742
Update README.md
Hexagon Nov 26, 2021
f668c93
Documentation
Hexagon Nov 26, 2021
9175759
Update dev deps, update documentation, bump.
Hexagon Dec 1, 2021
83f0103
Update dev dependencies, bump.
Hexagon Dec 12, 2021
fe9dfa6
Lint .md
Hexagon Dec 12, 2021
d5879c5
Update dependencies
Hexagon Dec 17, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
37 changes: 37 additions & 0 deletions .eslintrc.json
@@ -0,0 +1,37 @@
{
"rules": {
"indent": [
2,
"tab"
],
"quotes": [
2,
"double"
],
"semi": [
2,
"always"
],
"complexity": [
2,
22
],
"linebreak-style": 0,
"no-var": 1
},
"parserOptions": {
"sourceType": "module"
},
"ignorePatterns": ["dist-legacy/*","dist/*","docs/*"],
"globals": {
"define": false,
"describe": false,
"it": false
},
"env": {
"es6": true,
"node": true,
"browser": true
},
"extends": "eslint:recommended"
}
1 change: 1 addition & 0 deletions .github/FUNDING.yml
@@ -0,0 +1 @@
github: [hexagon]
6 changes: 6 additions & 0 deletions .github/dependabot.yml
@@ -0,0 +1,6 @@
version: 2
updates:
- package-ecosystem: "npm" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "daily"
76 changes: 76 additions & 0 deletions .github/workflows/codeql-analysis.yml
@@ -0,0 +1,76 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL"

on:
push:
branches: [ master ]
paths:
- 'src/**'
pull_request:
# The branches below must be a subset of the branches above
branches: [ master ]
paths:
- 'src/**'
schedule:
- cron: '39 11 * * 2'

jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write

strategy:
fail-fast: false
matrix:
language: [ 'javascript' ]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
# Learn more:
# https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed

steps:
- name: Checkout repository
uses: actions/checkout@v2

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main

# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v1

# ℹ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl

# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project
# uses a compiled language

#- run: |
# make bootstrap
# make release

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1

30 changes: 30 additions & 0 deletions .github/workflows/node.js.yml
@@ -0,0 +1,30 @@
# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions

name: Node.js CI

on:
push:
branches: [ master ]
pull_request:
branches: [ master ]

jobs:
build:

runs-on: ubuntu-latest

strategy:
matrix:
node-version: [12.x, 14.x, 16.x]
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/

steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
cache: 'npm'
- run: npm ci
- run: npm run build:ci
18 changes: 18 additions & 0 deletions .github/workflows/npm.yml
@@ -0,0 +1,18 @@
name: Publish to NPM
on:
release:
types: [created]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
# Setup .npmrc file to publish to npm
- uses: actions/setup-node@v2
with:
node-version: '12.x'
registry-url: 'https://registry.npmjs.org'
- run: npm install
- run: npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
56 changes: 29 additions & 27 deletions .gitignore
@@ -1,27 +1,29 @@
# Logs
logs
*.log

# Runtime data
pids
*.pid
*.seed

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# node-waf configuration
.lock-wscript

# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release

# Dependency directory
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
node_modules
# Logs
logs
*.log

# Runtime data
pids
*.pid
*.seed

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# node-waf configuration
.lock-wscript

# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release

# Dependency directory
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
node_modules
testing.js
test.js
94 changes: 94 additions & 0 deletions .jsdoc.json
@@ -0,0 +1,94 @@
{
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc", "closure"]
},
"source": {
"include": ["README.md","./src/"],
"exclude": ["./docs"],
"excludePattern": "(node_modules|test|dist|coverage|^|\\/|\\\\)_"
},
"plugins": [
"plugins/markdown"
],
"recurseDepth": 2,
"template": {
"title": "Croner",
"shortTitle": "Croner",
"logo": "https://cdn.jsdelivr.net/gh/hexagon/croner@master/croner.png",
"links": [
{"github": "https://github.com/hexagon/croner", "title": "View it on Github"},
{"npm": "https://www.npmjs.com/package/croner", "title": "View it on NPM", "size": 19}
],
"scheme": "0",
"disableSort": false,
"font": {
"titleFont": "Roboto",
"textFont": "Roboto",
"codeFont": "Roboto Mono"
}
},
"styleSwitcher": false,
"colors": [
{
"text": {
"primary": "#dcdcdc",
"contrast": "#f78200"
},
"background": {
"primary": "#282c34",
"contrast": "#1d2027"
}
},
{
"text": {
"primary": "#dcdcdc",
"contrast": "#5ebd3e"
},
"background": {
"primary": "#282c34",
"contrast": "#1d2027"
}
},
{
"text": {
"primary": "#dcdcdc",
"contrast": "#ffb900"
},
"background": {
"primary": "#282c34",
"contrast": "#1d2027"
}
},
{
"text": {
"primary": "#dcdcdc",
"contrast": "#e23838"
},
"background": {
"primary": "#282c34",
"contrast": "#1d2027"
}
},
{
"text": {
"primary": "#dcdcdc",
"contrast": "#009cdf"
},
"background": {
"primary": "#282c34",
"contrast": "#1d2027"
}
}
],
"fonts": {
"text": "Alegreya+Sans|Alfa+Slab+One|Bangers|Bungee|Changa+One|Exo|Fira+Sans|Heebo|IBM+Plex+Sans|Lalezar|Lato|Open+Sans|Oswald|PT+Sans|Passion+One|Patua+One|Questrial|Raleway|Righteous|Roboto|Rubik|Source+Sans+Pro|Squada+One|Titillium+Web|Voces",
"code": "Cousine|Cutive+Mono|IBM+Plex+Mono|Inconsolata|Nanum+Gothic+Coding|Oxygen+Mono|PT+Mono|Share+Tech+Mono|Source+Code+Pro|Ubuntu+Mono|VT323"
},
"opts": {
"destination": "./docs/",
"encoding": "utf8",
"private": false,
"template": "./node_modules/jsdoc-chameleon-template"
}
}
59 changes: 59 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,59 @@
# Welcome to Croner contributing guide

## New contributor guide

To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions:

- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow)
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)

## Getting started

### Issues

#### Create a new issue

If you spot a problem with Croner, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/hexagon/croner/issues/new/choose).

#### Solve an issue

Scan through our [existing issues](https://github.com/hexagon/croner/issues) to find one that interests you. You can narrow down the search using `labels` as filters. If you find an issue to work on, make a note in the comments so er van assign it to you. Then you are welcome to open a PR with a fix.

### Make Changes

#### Setting up the environment

Se recommend using VS Code with eslint extensions, which will automatically check your code against THE defined rules as you write it.

1. Fork the repository.
- Using GitHub Desktop:
- [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)!
- Using the command line:
- [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.
2. Install or update to **Node.js v16**.
3. Create a working branch ```feature/my-cool-feature``` or ```bugfix/issue-14``` and start with your changes!

### Commit your update

Please run ```npm run build``` before committing, to update the dist-files, and to make sure every test and check passes. If you make changes to any function Interface, or to JSDoc in general, you should also run ```npm run build:docs``` to update the generated documentation.

See [package.json](/package.json) scripts section for all available scripts.

Then, commit the changes once you are happy with them.

### Pull Request

When you're finished with the changes, create a pull request, also known as a PR.
- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge.
Once you submit your PR, a team member will review your proposal. We may ask questions or request for additional information.

- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
- If you run into any merge issues, checkout this [git tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts) to help you resolve merge conflicts and other issues.

### Success

This guide is based on [GitHub Docs CONTRIBUTING.md](https://github.com/github/docs/blob/main/CONTRIBUTING.md)