We would love for you to contribute to LCUI and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:
Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on Stack Overflow where the questions should be tagged with tag lcui
.
Stack Overflow is a much better place to ask questions since:
To save your and our time, we will systematically close all issues that are requests for general support and redirect people to Stack Overflow.
If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.
You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it. Please consider what kind of change it is:
Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. Having a live, reproducible scenario gives us wealth of important information without going back & forth to you with additional questions like:
Before you submit your Pull Request (PR) consider the following guidelines:
master
branch is basically just a snapshot of the latest stable release. All development should be done in dedicated branches. Do not submit PRs against the master
branch.
develop
, and merge back against that branch.make test
passes.(fix #xxxx[,#xxx])
(#xxxx is the issue id) in your PR title for a better release log, e.g. update entities encoding/decoding (fix #3899)
.To ensure consistency throughout the source code, keep these rules in mind as you are working:
clang-format --style=file [src/????.c]
.npm install
, which will add a git hook to format the changed code, and it will run before you run git commit
.We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the LCUI change log.
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory and the scope of the header is optional.
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
Footer should contain a closing reference to an issue if any.
Samples: (even more samples)
docs(changelog): update change log to beta.1
Use this format, we can easily filter out commits that we do not want to see, for example:
# show commits that contain new features
git log --pretty=format:"%h %ad %s %d" --date=short --grep "^feat"
# show commits that contain functional code changes (including features, bug fixes, refactorings and improvements)
git log --pretty=format:"%h %ad %s %d" --date=short --grep "^\(feat\|fix\|refactor\|perf\)"
If the commit reverts a previous commit, it should begin with revert:
, followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>.
, where the hash is the SHA of the commit being reverted.
Must be one of the following:
The scope could be anything specifying place of the commit change. For example timer
, mainloop
, renderer
, layout
, css
, font
, widget
etc...
The subject contains succinct description of the change:
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.
Breaking Changes should start with the word BREAKING CHANGE:
with a space or two newlines. The rest of the commit message is then used for this.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。