chance-mixin-guidelines.md

Initiative

[ecosystem] Mixin repo · Issue #240 · chancejs/chancejs
Consider splitting across multiple packages / modules? · Issue #52 · chancejs/chancejs

---

Guidelines for mixin

1. The repo SHALL be named chance-${mixin_name}
2. keywords SHALL include these values for search in npm:

"keywords": [
  "chance",
  "chancejs",
  "chancejs-mixin",
  ...${mixin_keywords}
]

3. chance MUST be added as peerDependencies
4. Mixin SHOULD be written in ES5 so compatibility is the broadest
5. Mixin SHOULD provide a build for browser usage
6. Mixin are RECOMMENDED to include tests, coverage report

---

Discussion

• better way to discuss than this Gist? Slack? Google Drive?
• invite author as Mixin Team member?
  The org I was in grant repo rw access to members
  But with the introduction of Team (verify: Team member must be org member?) we may do it a bit differently
  Need to check out GitHub docs and look for suggested solutions
• who publish to npm?
  mixin author or victorquinn?
  we can add multiple maintainer per npm package after published
• setup CI after moving repo to chancejs org
  but author cannot move repo if they are not member (verify: will Team member suffice?)
• mixin template (README, package.json, test tool)