Thank you for the interest in Contributing to Clockify CLI.
We accept pull requests for bug fixes and features (preferably that were discussed on an issue before). Also opening issues with feature requests and reporting bugs are very important contributions.
Please do:
- Check in the issues if the bug or feature request has not been submitted.
- Open an issue if things aren't working as expected.
- Open an issue to propose new features or improvements on existing ones.
- Open a pull request to fix a bug.
- Open a pull request for any open issue labelled
type: enhancement.
Please avoid:
- Opening pull requests for issues marked as
blocked.
All enhancement and bug issues are marked with a level label, it may help you know the
size/complexity of it.
Prerequisites:
- Go 1.19+
Run make deps-install to install the packages used by the project.
Run make deps-upgrade if you need to upgrade all of them, run go help get to see how to update
individual ones.
To build your changes into a binary run make dist, all three versions (Windows, Mac and Linux)
will be created under the dist/ folder.
You can also just run go run cmd/clockify-cli/main.go to execute the source directly.
See the project layout documentation to know where to find and create specific components.
Contributions to this project are released to the public under the project's open source license. By participating in this project you agree to abide by its terms.
We generate manual pages from source on every release. You do not need to submit pull requests for documentation specifically; manual pages for commands will automatically get updated after your pull requests gets accepted.
With gh
- Clone this repository
- Make and commit your changes.
- Submit a pull request:
gh pr create --web - In its body link which issue it is related, if there is one
- Fork the repository
- Make and commit your changes
- Open a pull request
- In its body link which issue it is related, if there is one
This document is based on the CONTRIBUTING.md from github/cli/cli.