diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/404.html b/404.html new file mode 100644 index 0000000..ed64060 --- /dev/null +++ b/404.html @@ -0,0 +1 @@ +
All notable changes to this project will be documented in this file.
Miscellaneous Tasks
Refactor
Build
Miscellaneous Tasks
Ci
Refactor
Bug Fixes
Miscellaneous Tasks
Refactor
Styling
Build
Bug Fixes
Build
Bug Fixes
Bug Fixes
Documentation
Features
Miscellaneous Tasks
Refactor
Bug Fixes
Documentation
Features
Miscellaneous Tasks
Refactor
verbose
flag (28f865d)Testing
Build
Ci
Contributions are welcome, and they are greatly appreciated! Every little helps, and credit will always be given. You can contribute in many ways.
Report bugs at https://github.com/gabor-boros/minutes/issues.
If you are reporting a bug, please use the bug report template, and include:
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.
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.
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.
The best way to send feedback is to file an issue.
If you are proposing a feature:
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.
$ git clone git@github.com:your_name_here/minutes.git
+
$ cd minutes
+$ make prerequisites
+$ make deps
+$ python -m virtualenv -p python3 virtualenv
+$ pip install -r www/requirements.txt
+
$ git checkout -b github-username/bugfix-or-feature-name
+
$ make format
+$ make lint
+$ make test
+
make docs
We use conventional commits, and we require every commit to follow this pattern.
$ git add .
+$ git commit -m "action(scope): summary"
+$ git push origin github-username/bugfix-or-feature-name
+
Before you submit a pull request, check that it meets these guidelines:
A reminder for the maintainers on how to release.
Before doing anything, ensure you have git-cliff installed, and you already executed make prerequisites
.
make format
returns 0)make lint
returns 0)TAG="<CURRENT RELEASE VERSION>" make changelog
GITHUB_TOKEN="<TOKEN>" make release
to package the tool and create a GitHub releasev<NEXT RELEASE VERSION>
patternThe MIT License (MIT)
Copyright © 2021 Gabor Boros gabor.brs@gmail.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.