Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add project documentation and changelog generation
- Loading branch information
1 parent
466aa6d
commit c82e766
Showing
19 changed files
with
726 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| name: Docs | ||
|
|
||
| 'on': | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - www/* | ||
| pull_request: { } | ||
|
|
||
| jobs: | ||
| deploy: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - uses: actions/setup-python@v2 | ||
| with: | ||
| python-version: 3.x | ||
| - run: pip install -r www/requirements.txt | ||
| - run: cd www && mkdocs gh-deploy --force |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| # Changelog | ||
|
|
||
| All notable changes to this project will be documented in this file. | ||
|
|
||
| ## [unreleased] | ||
|
|
||
| **Bug Fixes** | ||
|
|
||
| - Solve time parsing issue when start or end date is defined (3d9c7be) | ||
|
|
||
| **Documentation** | ||
|
|
||
| - Add readme file (6784310) | ||
| - Add code of conduct (6b29c4f) | ||
| - Update go install instructions (a91840f) | ||
| - Add project documentation and changelog generation (48b7f98) | ||
|
|
||
| **Features** | ||
|
|
||
| - Initial worklog implementation (b73017b) | ||
| - Add basic client implementation (2501bcc) | ||
| - Add basic tempo client implementation (202ac41) | ||
| - Add basic clockify client implementation (cb04282) | ||
| - Add initial CLI implementation (98a6759) | ||
|
|
||
| **Miscellaneous Tasks** | ||
|
|
||
| - Add MIT license (3c3b64c) | ||
| - Add initial .gitignore (47e5b92) | ||
| - Add dependencies (1a24535) | ||
| - Add issue templates (99fba16) | ||
| - Add virtualenv to gitignore (466aa6d) | ||
|
|
||
| **Refactor** | ||
|
|
||
| - Rename worklog search and create path (b3d1ede) | ||
| - Return a list of entries instead of a pointer to a list of entries (000a6b7) | ||
| - Rename every occurance of item to entry (38f37ab) | ||
| - Update command headline (e1fa381) | ||
| - Replace table printer and refactor utils (67721bf) | ||
| - Rename tasks-as-tags to tags-as-tasks and tasks-as-tags-regex to tags-as-tasks-regex (180126b) | ||
| - Rename ci.yml to build.yml (4165ea4) | ||
| - Rename codeql-analysis.yml to codeql.yml (88edae1) | ||
|
|
||
| **Testing** | ||
|
|
||
| - Add benchmarks for NewWorklog (87f6767) | ||
| - Remove unused mock server opts (9fba963) | ||
| - Use UTC for time zone in tests (145031e) | ||
|
|
||
| **Build** | ||
|
|
||
| - Add initial Makefile (d25eab8) | ||
| - Add post build hook to call upx (6391c0f) | ||
|
|
||
| **Ci** | ||
|
|
||
| - Add CodeQL integration (29d4b74) | ||
| - Setup PR builds (210c58f) | ||
| - Update cron frequency (05db753) | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| # Contributing | ||
|
|
||
| Contributions are welcome, and they are greatly appreciated! Every little helps, and credit will always be given. You can contribute in many ways. | ||
|
|
||
| ## Types of Contributions | ||
|
|
||
| ### Report Bugs | ||
|
|
||
| Report bugs at <https://github.com/gabor-boros/minutes/issues>. | ||
|
|
||
| If you are reporting a bug, please use the bug report template, and include: | ||
|
|
||
| - your operating system name and version | ||
| - any details about your local setup that might be helpful in troubleshooting | ||
| - detailed steps to reproduce the bug | ||
|
|
||
| ### Fix Bugs | ||
|
|
||
| Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it. | ||
|
|
||
| ### Implement Features | ||
|
|
||
| Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it. In case you added a new source or target, do not forget to add them to the docs as well. | ||
|
|
||
| ### Write Documentation | ||
|
|
||
| Minutes could always use more documentation, whether as part of the docs, in docstrings, or even on the web in blog posts, articles, and such. | ||
|
|
||
| ### Submit Feedback | ||
|
|
||
| The best way to send feedback is to file an [issue](https://github.com/gabor-boros/minutes/issues). | ||
|
|
||
| If you are proposing a feature: | ||
|
|
||
| - explain in detail how it would work | ||
| - keep the scope as narrow as possible, to make it easier to implement | ||
| - remember that this is a volunteer-driven project, and that contributions are welcome :) | ||
|
|
||
| ## Get Started! | ||
|
|
||
| Ready to contribute? Here's how to set up `minutes` for local development. | ||
|
|
||
| As step 0 make sure you have Go 1.17+ and Python 3 installed. | ||
|
|
||
| 1. Fork the repository | ||
| 2. Clone your fork locally | ||
|
|
||
| ```shell | ||
| $ git clone git@github.com:your_name_here/minutes.git | ||
| ``` | ||
|
|
||
| 3. Install prerequisites | ||
|
|
||
| ```shell | ||
| $ cd minutes | ||
| $ make prerequisites | ||
| $ make deps | ||
| $ python -m virtualenv -p python3 virtualenv | ||
| $ pip install -r www/requirements.txt | ||
| ``` | ||
|
|
||
| 4. Create a branch for local development | ||
|
|
||
| ```shell | ||
| $ git checkout -b github-username/bugfix-or-feature-name | ||
| ``` | ||
|
|
||
| 5. When you're done making changes, check that your changes are formatted, passing linters, and tests are succeeding | ||
|
|
||
| ```shell | ||
| $ make format | ||
| $ make lint | ||
| $ make test | ||
| ``` | ||
|
|
||
| 6. Update documentation and check the results by running `make docs` | ||
| 7. Commit your changes and push your branch to GitHub | ||
|
|
||
| We use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/), and we require every commit to | ||
| follow this pattern. | ||
|
|
||
| ```shell | ||
| $ git add . | ||
| $ git commit -m "action(scope): summary" | ||
| $ git push origin github-username/bugfix-or-feature-name | ||
| ``` | ||
|
|
||
| 8. Submit a pull request on GitHub | ||
|
|
||
| ## Pull Request Guidelines | ||
|
|
||
| Before you submit a pull request, check that it meets these guidelines: | ||
|
|
||
| 1. The pull request should include tests | ||
| 2. Tests should pass for the PR | ||
| 3. If the pull request adds new functionality, or changes existing one, the docs should be updated | ||
|
|
||
| ## Releasing | ||
|
|
||
| A reminder for the maintainers on how to release. | ||
|
|
||
| Before doing anything, ensure you have [git-cliff](https://github.com/orhun/git-cliff) installed, and you already | ||
| executed `make prerequisites`. | ||
|
|
||
| 1. Make sure every required PR is merged | ||
| 2. Make sure every test is passing both on GitHub and locally | ||
| 3. Make sure that formatters are not complaining (`make format` returns 0) | ||
| 4. Make sure that linters are not complaining (`make lint` returns 0) | ||
| 5. Take a note about the next release version, keeping semantic versioning in mind | ||
| 6. Update the CHANGELOG.md using `TAG="<new release version>" make changelog` | ||
| 7. Compare the CHANGELOG.md changes and push to master | ||
| 8. Cut a new tag for the next release version | ||
| 9. Run `GITHUB_TOKEN="<TOKEN>" make release` to package the tool and create a GitHub release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.