菜单

贡献流程

相关源文件

本文档介绍了为 Front-end Developer Interview Questions 仓库贡献的步骤。它涵盖了从 fork 仓库到提交 pull request 的整个工作流程,以及对贡献者的指导和期望。有关贡献者在贡献被接受后如何获得认可的信息,请参阅贡献者认可

贡献工作流程概述

Front-end Developer Interview Questions 项目遵循标准的 GitHub fork 和 pull request 工作流程。该项目鼓励社区贡献,同时通过结构化的审查流程来维护质量。

来源:.github/CONTRIBUTING.md27-84

贡献类型

该项目接受多种类型的贡献,每种类型都需要略微不同的方法。

贡献类型描述指南
新问题添加一个全新的面试问题必须与前端开发相关
问题修订改进或更新现有问题应增强清晰度或相关性
基础设施更改更新构建过程、模板等需要对项目设置有技术理解
翻译更新或添加翻译必须遵循现有的语言文件结构
错误修复纠正现有内容中的错误应包含对问题的清晰解释

注意:本项目明确不接受包含面试问题答案的贡献。

来源:.github/PULL_REQUEST_TEMPLATE.md5-12 .github/ISSUE_TEMPLATE.md3-6

贡献文件及其关系

来源:.github/CONTRIBUTING.md .github/PULL_REQUEST_TEMPLATE.md .github/ISSUE_TEMPLATE.md .github/CODE_OF_CONDUCT.md

详细贡献步骤

1. Fork 并克隆仓库

第一步是创建您自己的仓库副本,并设置与原始仓库的连接。

Fork 并克隆仓库

  1. 导航到 GitHub 上的repository on GitHub
  2. 点击“Fork”按钮创建您自己的副本
  3. 将您的Fork克隆到本地计算机
    git clone https://github.com/<your-username>/Front-end-Developer-Interview-Questions.git
    cd Front-end-Developer-Interview-Questions
    
  4. 将原始仓库添加为 remote
    git remote add upstream https://github.com/h5bp/Front-end-Developer-Interview-Questions.git
    

来源:.github/CONTRIBUTING.md30-39

2. 保持 Fork 的更新

在开始新的贡献工作之前,请确保您的本地仓库与上游仓库同步。

git checkout main
git pull upstream main

来源:.github/CONTRIBUTING.md41-46

3. 创建主题分支

为您的更改创建一个新分支

git checkout -b <topic-branch-name>

选择一个描述性的分支名称,以反映您更改的目的,例如 add-accessibility-questionfix-css-question-typo

来源:.github/CONTRIBUTING.md48-53

4. 设置本地开发环境

要在本地测试您的更改,请设置开发环境。

npm install
npm start

这将安装所有依赖项,并在 http://:9090 启动一个本地服务器,让您预览带有您更改的网站。

来源:.github/CONTRIBUTING.md61-68

5. 进行和测试您的更改

对仓库进行您想要的更改。该项目是使用静态站点生成器 Eleventy 构建的。

  • 对于问题更改,请编辑源目录中的相应 markdown 文件。
  • 对于基础设施更改,请参阅Eleventy 文档
  • 对于翻译,请修改相关的语言文件。

通过查看本地运行的网站来测试您的更改,以确保一切外观和功能都符合预期。

来源:.github/CONTRIBUTING.md69-74

6. 准备您的贡献以供提交

在提交您的更改之前

  1. 将您的 commit 合并为一个干净的 commit
    git rebase -i main
    
  2. 将您的主题分支推送到您的 fork
    git push origin <topic-branch-name>
    

来源:.github/CONTRIBUTING.md75-81

7. 提交 Pull Request

从您的 fork 的分支打开一个 pull request 到主仓库。

  1. 导航到 GitHub 上的您的 fork
  2. 选择您的主题分支
  3. 点击“Pull Request”
  4. 使用相关信息填写 pull request 模板
  5. 提交 pull request

来源:.github/CONTRIBUTING.md83-84 .github/PULL_REQUEST_TEMPLATE.md

贡献指南

主要要求

  1. 每个问题一个 PR - 为每个新问题或修改的问题提交单独的 pull request。
  2. 不含答案 - 请勿在您的贡献中包含问题答案。
  3. MIT 许可证协议 - 通过提交贡献,您同意您的作品在 MIT 许可证下授权。
  4. 代码风格一致性 - 遵循现有的代码风格和约定。
  5. 自我审查 - 在提交前审查您自己的更改。

来源:.github/CONTRIBUTING.md6 .github/CONTRIBUTING.md86 .github/ISSUE_TEMPLATE.md5

使用 Issue Tracker

可以使用issue tracker 用于

  • 报告拼写错误
  • 报告错误
  • 提供一般性反馈
  • 讨论基础设施问题

不应用于

  • 提出问题答案
  • 恶意干扰讨论

对于新问题或对现有问题的修订,请提交 pull request 而不是打开 issue。

来源:.github/CONTRIBUTING.md14-21 .github/ISSUE_TEMPLATE.md1-6

行为准则

本项目遵循贡献者公约行为准则,该准则规定了社区参与的期望。

预期行为

  • 使用受欢迎且包容的语言
  • 尊重不同的观点
  • 优雅地接受建设性批评
  • 关注社区的最佳利益
  • 对社区成员表示同理心

不可接受的行为

  • 骚扰或歧视性语言
  • 人身攻击或侮辱性评论
  • 公开或私下骚扰
  • 发布他人的私人信息
  • 其他不专业行为

行为准则适用于项目空间内部以及代表项目时的公开场合。

来源:.github/CODE_OF_CONDUCT.md

本地开发设置

在克隆了存储库并使用 npm install 安装完依赖后,使用 npm start 来运行本地开发服务器。这将以开发模式启动 Eleventy,该模式会

  1. http://:9090 提供网站服务
  2. 监视文件更改
  3. 在文件被修改时自动重新构建和刷新

这样你就可以立即看到你的更改在部署后会是什么样子。

来源:.github/CONTRIBUTING.md61-74

拉取请求审查流程

提交拉取请求后,它将进入审查流程

  1. 初步检查:自动化检查会验证你的贡献是否满足基本要求
  2. 维护者审查:项目维护者会审查你的更改
  3. 讨论:维护者可能会要求你进行更改或提供更多信息
  4. 迭代:你可能需要根据反馈进行额外的更改
  5. 批准:一旦获得批准,你的贡献将被合并

拉取请求被视为一种对话。在维护者与你一起完善你的贡献并合并之前,请期待一些来回的讨论。

来源:.github/PULL_REQUEST_TEMPLATE.md20-22

成功贡献的最佳实践

  1. 从小处着手:从简单的贡献开始,熟悉流程
  2. 保持耐心:维护者是志愿者,审查可能需要时间
  3. 积极响应:在收到反馈时及时处理
  4. 保持清晰:在拉取请求描述中为你的更改提供背景信息
  5. 彻底测试:确保你的更改在提交前按预期工作
  6. 遵循约定:遵守存储库现有的风格和结构

通过遵循这些指南,你将有助于确保你的贡献被接受,并成为 Front-end Developer Interview Questions 项目中有价值的一部分。