美文网首页git
如何参与一个开源项目

如何参与一个开源项目

作者: 深度剖析JavaScript | 来源:发表于2022-01-16 21:26 被阅读0次

    如何参与一个开源项目,提交我的第一次PR

    vue-devui为例,步骤如下

    1. fork仓库
    2. 生成和配置SSH公钥
    3. clone个人仓库代码
    4. 本地启动项目
    5. 本地开发和提交代码
    6. 设置upstream和同步源仓库最新代码
    7. 提交PR

    但每个项目会有所不同,那怎么办?

    其实在项目的根目录下有个README文档,里头一般会有贡献指南之类的东西,它会教我们如何参与该项目

    举例:我们要给掘金贡献Markdown主题

    我们可以到项目的根目录的文档中去看,就可以看到贡献步骤:

    1. 使用默认模板创建一个公开的仓库(点击绿色的 Use this template 按钮)
    2. 将其中的 juejin.scss 替换为自己创作的样式,目前支持 Sass,Less 和 CSS
    3. 使用主题开发工具在本地预览主题效果
    4. Fork 此仓库并克隆到本地,在 themes.js 文件中指明样式文件的路径,ref 为 commit hash,highlight 为默认的代码高亮主题(可选)
    5. README.md 中「社区主题」章节中添加你的主题和作者信息
    6. 提交 pull request (注意:commit 信息要使用 'feat: ' 和 'fix: ' 形式,否则无法触发自动化发布流程)
    7. 提交 PR 前请 rebase,确保 commit 记录的整洁
    8. 如果是修复样式 bug,请在 PR 中给出明确的描述信息
    9. 注意考虑样式的稳定性和兼容性
    10. 并非所有 PR 的主题都会入选,挑选和审核会有一定周期

    相关文章

      网友评论

        本文标题:如何参与一个开源项目

        本文链接:https://www.haomeiwen.com/subject/ocyacrtx.html