Development Guidelines

PR 审查的要求，以更快地合并现有的和新的 pull 请求:

• 如果 pull 请求是一个带有测试的小 bug 修复，那么只需要一个 (1) 核心开发者审查。
• 如果 pull 请求是一个特性或重大更改，那么至少需要两名核心开发人员进行审查。
• 如果 pull 请求来自核心开发人员，则只需要另一个 (1) 核心开发人员评审，除非该评审人员建议更多的评审人员。
• 如果 pull 请求是一个带有测试的小 bug 修复，那么这个核心开发人员 (此修复的作者) 可以在不进行任何检查的情况下合并它。
• 应该添加更多没有提交权限的 PR 审稿人!
• 每个版本将有一个版本管理人员来管理应该包括哪个 PR。

如何通过在其上执行 “squash” 或 “rebase” 准备即将合并到主分支上的 pull 请求:

https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request

本地构建、安装和测试

这些假设工作目录是存储库的根目录。 使用 VS2015 在 windows 上构建和安装系统 python:

• python setup.py install

使用 VS2017:

• python setup.py install --xplat

运行 clr 测试:

• python -m pytest

如何修改版本

安装 bumpversion (pip install bumpversion)，然后用其中一个来修改版本:

• bumpversion patch: 0.1.0 -> 0.1.1.dev0
• bumpversion release: 0.1.1.dev0 -> 0.1.1
• bumpversion minor: 0.1.1 -> 0.2.0.dev0
• bumpversion major: 0.1.1 -> 1.0.0.dev0
• bumpversion dev: 0.2.0.dev0 -> 0.2.0.dev1
• bumpversion release: 0.2.0.dev1 -> 0.2.0

这将更新源代码中所有相关和需要的 版本 字符串。不需要手动更新版本!

待办事项

• 调试 (PTVS 和 PyCharm)
• 代码风格和 IDE 配置
• git 工作流
• 测试 (嵌套测试)
• Travis CI 和 Appveyor
• PYPI 版本
• Chocolatey 和 nuget
• 设计及实现笔记
• 第三方依赖