Contributing to Croner
To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:
If you're looking to support Croner financially, consider checking out our Sponsorship page.
Scan through our existing 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 we can assign it to you. Then you are welcome to open a PR with a fix.
We recommend using VS Code with eslint extensions, which will automatically check your code against the defined rules as you write it.
- Fork the repository.
- Using 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!
- Using the command line:
- Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
- Install or update to Node.js v16.
- Base your work on the
- Create a working branch
bugfix/issue-14and start with your changes!
Make sure you add test cases for your changes. While developing, use
npm run test to run run quick tests against
npm run build before committing, to update the dist-files, and to make sure every test and check passes. When using this command, both source code, and all generated code will be tested, so it can take a while.
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 scripts section for all available scripts.
Then, commit the changes once you are happy with them.
When you're finished with the changes, create a pull request, also known as a PR.
- Don't forget to link PR to issue if you are solving one.
- Enable the checkbox to allow maintainer edits 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 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.
- If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.
This guide is based on GitHub Docs CONTRIBUTING.md