Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Best practice for leveraging cfEnv?

未关闭
#12 4 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
功能
描述清晰度
需要澄清
活跃度
停滞
技术栈
coffeescript, node.js
领域
backend

调研方向

未指定文件或测试;先从 issue 中的 setup API 和 OLD/IMPROVED 示例开始,然后检查当前如何提供 cfEnv 凭据。完成的标准是:对提议的 appEnv 选项、其潜在问题和优先级,以及是否应记录由此得到的最佳实践,作出决定。

由索引模型根据 Issue 内容生成。

描述

Say I am writing an SDK (just suppose…)

Is the following reasonable, and if so, should it be documented as a best practice?

OLD:

 var appEnv = require('cfenv').getAppEnv();
 var someClient = require('Some Random Thing').setup({ credentials: appEnv.getServiceCreds(/Something.*/) });

IMPROVED?

 var appEnv = require('cfenv').getAppEnv();
 var someClient = require('Some Random Thing').setup({ appEnv: appEnv });

implemented within the SDK by:

 … function setup(opts) { 
    if(opts.appEnv && !opts.credentials) {  // if appEnv is available, use it
     opts.credentials = opts.appEnv.getServiceCreds( someRegex );
    }

Any pitfalls? My idea is to reduce the amount of copy and paste user code. User can just pass in appEnv if they have one, otherwise credentials can be supplied.

主要语言
CoffeeScript
星标
74
派生
25
PR 合并指标
30 天内没有已合并 PR

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

cloudfoundry-community/node-cfenv 的其他 Issue

查看 cloudfoundry-community/node-cfenv 的全部 Issue

相似的 Issue

更多 Backend & API Design Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。