贡献指南简介

SymPy 是由一大群贡献者创建和维护的，我们非常欢迎你也成为其中的一员！对于新贡献者来说，像 SymPy 这样庞大而复杂的机器可能会让人望而生畏。本页面旨在为新贡献者提供一些入门技巧。

熟悉使用该软件

我们建议在开始贡献之前，先阅读 SymPy 教程 以熟悉该软件的使用。这将帮助您熟悉 SymPy 的用途。

教程也可以在视频中找到：

阅读论文

我们在2017年撰写了一篇期刊论文，该论文从高层次上介绍了SymPy及其功能。你可以在这里阅读它：

https://peerj.com/articles/cs-103/

浏览文档

除了教程之外，文档 中还有更多信息。浏览一下不同的主题，了解一下还有哪些内容可用，这可能是个好主意。

审查行为准则

SymPy 社区的参与者应遵守我们的 行为准则。请在开始前查看此内容。

加入我们的邮件列表

SymPy 的 SymPy 邮件列表 是讨论 SymPy 的一个地方。你可以在那里询问如何使用 SymPy，讨论功能请求，讨论软件错误，或者分享你是如何使用 SymPy 的。请在 Google Groups 页面上申请加入该列表。注意，为了防止垃圾邮件，你第一次发布的消息需要经过审核后才能发布到列表中。在发帖前，请阅读 http://shakthimaan.com/downloads/book/chapter1.pdf 以熟悉邮件列表的礼仪。

设置你的开发环境

我们使用 Git 版本控制系统来跟踪软件 随时间的变化 并有效地管理 来自许多不同作者的贡献。我们还广泛使用 GitHub，一个 Git 的网络界面，用于沟通、问题跟踪、合并贡献（即拉取请求）等。

如果你是Git和GitHub的新手，请先阅读 设置开发环境 页面，了解如何设置你的开发环境。如果你已经熟悉GitHub的基本工作流程， 开发工作流程过程 页面描述了GitHub贡献工作流程中特定于SymPy的方面。

确定要处理的事项

有很多方式可以为 SymPy 做出贡献。大多数贡献集中在修复软件错误和为他们感兴趣的事情添加新功能。但我们还需要帮助的其他事情，比如维护我们的网站、编写文档、准备教程、在邮件列表、聊天室、StackOverflow 和问题跟踪器上回答人们的问题，以及审查拉取请求。以下是一些开始贡献的方式：

SymPy 代码库

开始使用主代码库的最佳方式是修复一些现有的错误。如果你在寻找一个可以修复的错误，你可以从问题跟踪器中标记为“易于修复”的问题开始，看看是否有你感兴趣的。如果不清楚如何修复，可以在问题本身或邮件列表中询问如何操作的建议。

SymPy 的代码被组织成 Python 包和模块。核心代码位于 sympy/core 目录中，而 sympy 目录中的其他包则包含更具体的代码，例如 sympy/printing 处理 SymPy 对象如何打印到终端和 Jupyter。

文档

SymPy 的文档存放在两个地方：

  1. 文档源文件: https://github.com/sympy/sympy/tree/master/doc/src

  2. 源代码中函数的文档字符串*：https://github.com/sympy/sympy/tree/master/sympy

这两个最终都会在文档网站上显示。你可以点击任何函数文档旁边的“[源代码]”链接，跳转到SymPy源代码中对应的docstring。

* SymPy 中的每个函数和类在其调用签名下方都有一个字符串，解释该对象的用途。这就是在 Python 中输入 help(function_name) 时显示的内容。

在为我们的文档做出贡献或进行改进时，请遵循 SymPy 文档风格指南。

审查拉取请求

每个对 SymPy 的贡献都通过一个拉取请求 https://github.com/sympy/sympy/pulls 进行。我们要求每个拉取请求在合并之前都要经过审查。如果你对 SymPy 代码库的某一部分和 SymPy 的开发流程有了一定的了解，审查他人的拉取请求将对社区有所帮助。你可以查看代码提交并检查它是否达到了预期的效果。