Best practice for leveraging cfEnv?
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 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 ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
cloudfoundry-community/node-cfenv のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 68/100
cloudfoundry-community/node-cfenv#2 · コメント 2 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 30/100
cloudfoundry-community/node-cfenv#53 · コメント 1 件 ·
-
typescript problemオープン
難易度 4/5 3〜5日 初心者へのやさしさ 30/100
cloudfoundry-community/node-cfenv#26 · コメント 8 件 · リアクション 6 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
cloudfoundry-community/node-cfenv#17 · コメント 2 件 ·
-
Invalid PORT valueオープン
難易度 3/5 1〜2日 初心者へのやさしさ 25/100
cloudfoundry-community/node-cfenv#13 · コメント 8 件 · リアクション 1 件 ·
cloudfoundry-community/node-cfenv の issue をすべて見る
似ている issue
-
bug effort:S priority:P2
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
typegoose/mongodb-memory-server#1040 ·
-
effort:low model:light plan planner:fable-5-1 test-quality tests
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信