同步操作将从 MqttsNet/thinglinks 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
We wholeheartedly welcome contributions to our project. Our mission is to foster a happy community where everyone helps each other!
There are many ways you can contribute to the ThingLinks community:
💻Code: Can help the community complete some tasks, write new features or fix some bugs;
⚠️Test: Can come to participate in the writing of test code, including unit testing, integration testing, e2e testing;
📖Docs: Can write or Documentation improved to help users better understand and use ThingLinks;
📝Blog: You can write articles about ThingLinks to help the community better promote;
🤔Discussion: You can participate in the discussion of new features of ThingLinks and integrate your ideas with ThingLinks;
💡Preach: Can help publicize or promote the ThingLinks community, speak in meetup or summit;
💬Suggestion: You can also make some suggestions to the project or community to promote the healthy development of the community;
More see Contribution Types
Even small corrections to typos are very welcome :)
Get ThingLinks' code running on your development tools and be able to debug. This is a front-end and back-end separated project. You need to start the back-end 'thinglinks' and front-end 'thinglinks-ui' separately to make them effective.
Find the issue you are interested in! On our GitHub repo issue list, we often publish some issues with the label good first issue or status: volunteer wanted. These issues welcome the help of contributors. Among them, good first issues tend to have low thresholds and are suitable for novices.
Of course, if you have a good idea, you can also propose it directly on GitHub Discussion or contact with community.
git clone https://github.com:${YOUR_USERNAME}/thinglinks.git #Recommended
git checkout -b a-feature-branch #Recommended
git add <modified file/path>
git commit -m '[docs]feature: necessary instructions' #Recommended
git push origin a-feature-branch
Please note that the title of the PR needs to conform to our spec, and write the necessary description in the PR to facilitate code review by Committers and other contributors.
After submitting the PR, the Committee or the community's friends will review the code you submitted (Code Review), and will propose some modification suggestions or conduct some discussions. Please pay attention to your PR in time.
If subsequent changes are required, there is no need to initiate a new PR. After submitting a commit on the original branch and pushing it to the remote repository, the PR will be automatically updated.
In addition, our project has a relatively standardized and strict CI inspection process. After submitting PR, CI will be triggered. Please pay attention to whether it passes the CI inspection.
Finally, the Committers can merge the PR into the main branch.
After the code has been merged, you can delete the development branch on both the local and remote repositories:
git branch -d a-dev-branch
git push origin --delete a-dev-branch
On the main/main branch, you can do the following to sync the upstream repository:
git remote add upstream https://github.com/mqttsnet/thinglinks.git #Bind the remote warehouse, if it has been executed, it does not need to be executed again
git checkout main
git pull upstream main
With the above steps, you are a contributor to ThingLinks. Repeat the previous steps to stay active in the community, keep at, you can become a Committer!
非常欢迎参与项目贡献,我们致力于维护一个互相帮助的快乐社区。
在 ThingLinks 社区,贡献方式有很多:
💻代码:可以帮助社区完成一些任务、编写新的feature或者是修复一些bug;
⚠️测试:可以来参与测试代码的编写,包括了单元测试、集成测试、e2e测试;
📖文档:可以编写或完善文档,来帮助用户更好地了解和使用 ThingLinks;
📝博客:可以撰写 ThingLinks 的相关文章,来帮助社区更好地推广;
🤔讨论:可以参与 ThingLinks 新的feature的讨论,将您的想法跟 ThingLinks 融合;
💡布道:可以帮助宣传或推广 ThingLinks 社区,在 meetup 或 summit 中演讲;
💬建议:也可以对项目或者社区提出一些建议,促进社区的良性发展;
更多贡献方式参见 Contribution Types
即便是小到错别字的修正我们也都非常欢迎 :)
让 ThingLinks 的代码在您的开发工具上运行起来,并且能够断点调试。
此为前后端分离项目,本地代码启动需将后端'thinglinks'和前端'thinglinks-ui'分别启动生效。
后端&前端启动
[可参考官方文档](https://mqttsnet.yuque.com/gt6zkc/thinglinks?# 《ThingLinks物联网一体化平台》)
寻找您感兴趣的Issue!在我们的GitHub仓库和邮件列表中,我们经常会发布一些带有 good first issue 或者 status: volunteer wanted 标签的issue,这些issue都欢迎贡献者的帮助。 其中good first issue往往门槛较低、适合新手。
当然,如果您有好的想法,也可以直接在GitHub Discussion 中提出或者联系社区。
git clone https://github.com:${YOUR_USERNAME}/thinglinks.git #Recommended
git checkout -b a-feature-branch #Recommended
git add <modified file/path>
git commit -m '[docs]feature: necessary instructions' #Recommended
git push origin a-feature-branch
请注意 PR 的标题需要符合我们的规范,并且在 PR 中写上必要的说明,来方便 Committer 和其他贡献者进行代码审查。
在提交了 PR 后,Committer 或者社区的小伙伴们会对您提交的代码进行审查(Code Review),会提出一些修改建议,或者是进行一些讨论,请及时关注您的PR。
若后续需要改动,不需要发起一个新的 PR,在原有的分支上提交 commit 并推送到远程仓库后,PR会自动更新。
另外,我们的项目有比较规范和严格的 CI 检查流程,在提交 PR 之后会触发 CI,请注意是否通过 CI 检查。
最后,Committer 可以将 PR 合并入DEV主分支。
在代码被合并后,您就可以在本地和远程仓库删除这个开发分支了:
git branch -d a-dev-branch
git push origin --delete a-dev-branch
在主分支上,您可以执行以下操作来同步上游仓库:
git remote add upstream https://github.com/mqttsnet/thinglinks.git #Bind the remote warehouse, if it has been executed, it does not need to be executed again
git checkout main
git pull upstream main
通过上述步骤,您就是 ThingLinks 的贡献者了。重复前面的步骤,在社区中保持活跃,坚持下去,您就能成为 Committer!
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。