Thank you for considering contributing to Klogg. It's people like you that make Klogg such a great tool.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests to writing code which can be incorporated into Klogg itself.
Klogg is intended to be a log viewing tool with additional features that help navigate through text files, extract information and reconstruct chain of events.
If you find yourself wishing for a feature that doesn't exist in Klogg, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that Klogg has today have been added because our users saw the need. Open an issue on GitHub which describes the feature you would like to see, why you need it, and how it should work.
If you find a security vulnerability, do NOT open an issue.
In order to determine whether you are dealing with a security issue, ask yourself these two questions:
If the answer to either of those two questions are "yes", then you're probably dealing with a security issue. Note that even if you answer "no" to both questions, you may still be dealing with a security issue, so if you're unsure, just email us at klogg@filimonov.dev.
When filing an issue, make sure to answer these five questions:
General questions do not need to follow this checklist. Feel free to ask anything about using, developing or distributing Klogg. Such questions often help to improve project documentation.
Klogg has become a quite complex tool with many features. Any time spent fixing
typos or clarifying sections in the documentation is greatly appreciated.
Features that need better documentation can be found in this
list.
Both open and closed issues marked with label status: need documentation
require some work with documentation.
Unsure where to begin contributing to Klogg? You can start by looking through these issues:
Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.
Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.
At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first
For something that is bigger than a ten line fix:
If possible commit message should be like prefix: message
, where prefix is one of
feat = 'Features',
fix = 'Bug Fixes',
docs = 'Documentation',
style = 'Styles',
refactor = 'Code Refactoring',
perf = 'Performance Improvements',
test = 'Tests',
build = 'Builds',
ci = 'Continuous Integration',
chore = 'Chores',
revert = 'Reverts',
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。