前言
在软件开发过程中，如何建立一个良好的社区文化是非常重要的。没有好的社区文化，开源项目的开发会变得混乱且难以维护。因此，许多开源项目都制定了自己的 Code of conduct（行为准则），用于规范社区成员的行为。
为了更方便地维护、使用这些行为准则，npm 上推出了一款名为 software-code-of-conduct 的 npm 包。这个包提供了一个开箱即用的行为准则模板，帮助项目以及社区更快更好地建立起规范的文化。
使用教程
使用该 npm 包非常简单，只需要通过 npm 安装即可。
npm install software-code-of-conduct
安装之后，在项目的根目录下，创建名为 CODE_OF_CONDUCT.md 的 Markdown 文件，并在其中添加如下内容：
-- -------------------- ---- ------- - ----------- -------- ---- -- ------- -- --- ------ -- --- -------- -- --------- -- ---- --- --------- ------------ -- -- ------------ --- ----------- ------ -- ------ ------------- -- --- ------- --- --- --------- - --------------- ---------- --- --------- ---------- -- ---- ---- ----- ----------- ---------- ------ -------- --- ----------- ----- -- ----------- ---------- -------------- ------- ------------ -------- ----------- ----- --------- -- ------ -------- --- ------------ -- --- --------- -------- -- -------- ---- ----------- -- -------- - -------- ----------- -------- - ----- --------- --- --------- -------- - ----- ---------- -- --------- ---------- --- ----------- - ---------- --------- ------------ --------- - -------- -- ---- -- ---- --- --- --------- - ------- ------- ------- ----- --------- ------- -------- -- ------------ -------- -- ------------ -------- - --- --- -- ---------- -------- -- ------- --- --------- ------ --------- -- -------- - --------- -------------------- --------- --- -------- -- --------- ------- - ------ -- ------- ---------- - ---------- ------- ------- ------------ ---- -- - -------- -- ----- -------- ------- ----- -------- ---------- - ----- ------- ----- ----- ---------- -- ---------- ------------- -- - ------------ ------- -- ----------- ---------------- ------- ----------- --- ----------- --- ---------- --- --------- -- ---------- -------- --- --- -------- -- ---- ----------- --- ---- ---------- ------ -- -------- -- --- --------- -- ------------ --------- ------- ----------- ---- --- ----- --- -------------- -- ------- ----- -- ------ --------- -------- ----- ---- ------ ------- --- ----- ------------- ---- --- --- ------- -- ---- ---- -- -------- -- -- --- ----------- -- ----------- --- ----------- --- ----- --------- ---- ---- ---- -------------- ------------ ---------- -- -------- -- ----- ---- ---- -- ------- ------- ---- ------ ------- ------ --- -- ------ ------ ---- -- ---------- -- ------------ --- ------- -- --- ---------- -------- -- ------------ - ------- -- --------- ------- ----- -- -------- ------- ------ -------- ------- --- -- -------- ------ ----- -------- -- ------ -- -- --------- -------------- -- -- ------ -- ------- ------ -------------- -- - ------- --- -- ------- ------- --- --------- -- ------- ------------ -- ----------- --------- -- -------- ---------- -- --------- ------------ -------- --- -- -------- -- ---------- --- ------- ---- -- ------- ----- --------- --- ---------- ---- -- -------- --- ------------ --- ---- ------ -- - -------- ---- -- ------ --------- --- ----------- -- --- -------------- --- ------- ---- -- --------- -- -------- --------------- ---- ------ -- --- -------- -- -- --------- ------- ------- -- -------- ----------- -------- --- -- ------ ----------- ------- ----------- --- -- --- ------ -- ------- --- ---- -- ------- -- ---- ----- --- ---- --------- -- --------- ------------- -- ---------- -- ----- ------- -- --- --------- ----------- -- ----------- ---- ---- -- ------- -- ------- ---- --- ------------ -------------------- ------- ---- --------- -- --------------------------------------------------------------------- ----------- ------------------------------------
在这个文件中，你可以根据你的项目需求修改行为准则的内容。具体指引已经在代码注释中说明。
学习意义
使用 software-code-of-conduct 这个 npm 包，可以帮助你快速创建一个规范的社区文化。同样地，学习创建一个良好的社区文化，可以提高自己的软件开发素养。
- 品牌价值。在开源项目中，许多人关注的不仅仅是代码质量和功能，还有诸如该项目的文化以及贡献者是否感受到自己的价值等等的情感细节。所以建立一个友善、公正、包容的文化将让你的项目在用户和贡献者之间建立信任。
- 社区管理。协作开发项目的时候，最容易引起分歧的是沟通。建立一个规范、公正的社区信仰，有助于构建良好的社区行为标准，让社区成员们能够更好地沟通和相互合作。
- 个人成长。参与到开源项目中，不仅可以为社区贡献代码，还可以学习如何在公开的邮件列表和讨论中与他人合作打交道。因此学习协作开发和建立良好文化的过程，是个人成长的重要旅程。
示例代码
以上是使用软件包的基本步骤，下面是该软件包中的示例代码。
const softwareCodeOfConduct = require('software-code-of-conduct');
console.log(softwareCodeOfConduct);输出：
# Contributor Covenant Code of Conduct ## Our Pledge In the ......
这个示例代码演示了如何引入软件包并输出其中的代码。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005571981e8991b448d405c