为羽毛做贡献

感谢您为Feathers做出贡献! :heart: :tada:

羽毛拥抱模块化,并在许多回购中被分解。为了使这更容易管理,我们目前使用Github项目进行问题分类和可见性。要获得核心版本的高级视图,您可以访问https://github.com/feathersjs/feathers/projects。

报告错误

在创建问题之前,请确保您已检出文档,特别是`FAQ <https://docs.feathersjs.com/help/faq.html>`_部分。您可能还想尝试搜索Github。很可能有人已经问了类似的问题。

如果你还没有找到你的答案,请随时加入我们的`slack channel <http://slack.feathersjs.com>`_,在Github上创建一个问题,或发布在`Stackoverflow <http://stackoverflow.com >`_使用``feathers``或``feathersjs``标签。我们尽力监控Stackoverflow,但您可能会在Slack和Github中获得更多即时响应。“

问题可以在`问题跟踪器<https://github.com/feathersjs/feathers/issues>`_中报告。由于羽毛结合了许多模块,因此我们很难在不知道正在使用哪些模块以及您的配置如何的情况下评估根本原因,所以**如果您可以链接到一个简单的示例来重现您的问题,它将极大地帮助我们* *

报告安全问题

我们非常重视Feathers的安全。我们欢迎任何同行评审我们的100%开源代码,以确保没有人的羽毛应用程序遭到入侵或黑客入侵。作为Web应用程序开发人员,您应对任何安全漏洞负责。我们尽最大努力确保Feathers在默认情况下尽可能安全。

为了让社区有时间回复和升级,我们强烈建议您向我们报告所有安全问题。请将一位核心团队成员发送给“Slack <http://slack.feathersjs.com>”的PM,或发送电子邮件至hello@feathersjs.com,我们将尽快回复。

有关详细信息,请参阅我们的`安全文档<https://docs.feathersjs.com/SECURITY.html>`_。

请求

我们:内心:拉取请求,我们不断努力让人们尽可能轻松地做出贡献,包括`插件生成器<https://github.com/feathersjs/generator-feathers-plugin>`_和`common test suite <https://github.com/feathersjs/feathers-service-tests>`_用于数据库适配器。

我们更喜欢使用最少的代码更改的小拉请求。它们越小越容易审查和合并。 FeathersJS维护人员会提取您的PR并尽快进行审核。他们可能会要求更改或拒绝您的拉取请求。这不是您作为工程师或个人的反映。请慷慨地接受反馈,因为我们在提供时也会尽量保持敏感。

虽然我们通常接受许多PR,但出于多种原因,它们可能会遭到拒绝。我们将尽可能透明,但可能只是因为您没有相同的上下文,历史知识或维护者所拥有的路线图信息。我们重视您将所有贡献汇总在一起所花费的时间,因此我们保证始终尊重那个时间并尽可能地保持开放,这样您就不会浪费它。 :微笑:

所有PR(文件除外)都应附有测试并通过linting规则。

代码风格

在从``test /``文件夹``npm test``运行测试之前,将运行ESlint。您可以通过运行``npm run lint``单独检查代码更改。

测试

Mocha tests位于``test /``文件夹中,可以使用``npm run mocha``或``npm test``运行(使用ESLint和代码覆盖率)命令。

文档

Feathers文档包含在`docs <https://github.com/feathersjs/docs>`_ repository中的Markdown文件中。要更改文档,请向该存储库提交拉取请求,引用任何其他PR(如果适用),并在下一版本中更新文档。

社区贡献

如果你已经为Feathers编写了一些很棒的东西,对于Feathers生态系统,或者使用Feathers创建了一个应用程序,请将它添加到`awesome-feathersjs <https://github.com/feathersjs-ecosystem/awesome-feathersjs>`_。

如果你想创建一个新的插件,你也可以查看`插件生成器<https://github.com/feathersjs/generator-feathers-plugin>`_,可以用来支持插件符合Feathers从头开始。

如果您认为您的模块是一个很好的核心``feathersjs``模块或``featherjs-ecosystem``模块,那么请联系`Slack <http://slack.feathersjs.com>`_中的一个Feathers维护者。我们可以讨论它是否属于如何以及如何实现它。 :啤酒:

贡献者行为准则

作为该项目的贡献者和维护者,我们承诺尊重所有通过报告问题,发布功能请求,更新文档,提交拉取请求或补丁以及其他活动做出贡献的人员。

无论经验水平,性别,性别认同和表达,性取向,残疾,个人形象,体型,种族,民族,年龄或宗教,我们都致力于为每个人提供无骚扰体验。

参与者不可接受的行为的例子包括使用性语言或图像,贬损评论或人身攻击,拖钓,公开或私人骚扰,侮辱或其他非专业行为。

项目维护者有权利和责任删除,编辑或拒绝与本行为准则不一致的评论,提交,代码,维基编辑,问题和其他贡献。不遵守行为准则的项目维护人员可能会从项目团队中删除。

可以通过打开问题或联系一个或多个项目维护者来报告滥用,骚扰或其他不可接受的行为的实例。

本行为准则改编自“贡献者契约<http://contributor-covenant.org>`_,版本1.0.0,可从http://contributor-covenant.org/version/1/0/0/获取