mongodb-js / mongodb-js.github.io Goto Github PK

• Send a PR to http://github.com/gitterHQ/services that adds wercker
• Add to mj templates

We need an operating model to make sure this org doesn't become a graveyard. Some questions that have come up:

• If tests are failing on a project's default branch, who is going to make sure it gets back to green quickly?
• Who makes sure pull requests are handled?
• Who makes sure issues created by users are considered and responded to?
• What checks can we put in place to make sure this all happens?
• Who settles disputes for combining/splitting modules?

I'm inclined to adapt iojs/GOVERNANCE.md to our needs. Adding a @mongodb-js/tc team would assign people to all of the above. Regularly scheduled (bi-weekly? monthly?) @mongodb-js/tc google hangouts would provide transparency and a way to make sure we're not slipping. @mongodb-js/tc would require just a few hours a week per member, but we're not blocked for 12 days because 1 team is really busy.

Thoughts?

Break off from #1. This would allow the mongodb org to fork and customize for their org page.

Setup information (see #6), Contributing instructions + branching model, links to useful plugins, etc.

From @medina:

I'd absolutely love for us to have a better view into all of these projects, e.g., what http://netflix.github.io is for https://github.com/Netflix. Perhaps the front-end-inclined could assist with that? :-)

I've been thinking about this quite a bit as well. Making sure tests are passing once, pull requests aren't languishing, something unexpectedly becoming very popular, etc is really hard once you have > 20 live modules. (see mongoscope/modules.md) So how about we try 2 birds with 1 stone? Some things to make this happen:

• project setup (usual toolchain)
• ping one of the npm search api's for all modules (eg keyword mongodb.js) or make a little heroku server endpoint hit github api for /repos (pull over ampersand models and collections from dyno)
• ideas for module avatars? configurable + default to http://robohash.org/
• sort repos by newest, # open issues, latest update, most popular, open pull requests
• popovers for grid layout
• fixed width list items in list layout

examples

• twitter src
• netflix src

https://github.com/mongodb-js/mini-breakpad-server

Thanks @rueckstiess!

mongodb-js/mj transfer:

• add #wip to description
• mj check

mongodb-js/mj needs:

• travisci hook
• travisci badge in README.md
• jshintrc
• jsfmtrc
• empty author field in package.json
• npm test fails

Say we want to offer automated installation of sublime plugins for new contributors via mj. It would be nice if that was its own npm module, e.g. sublime-pkg-installer.

That has nothing to do with MongoDB though. Does it still go in this org? Because mj depends on it?

What are alternatives? Host privately?

• setup main channel
• experiment with as destination for travis hooks

Should cover:

• how to install node.js/io.js on osx/linux/windows
• how to install and configure tooling (mj)

Can't do this by hand, so let's write some tooling to help.

• update badges in README
• update repo/url in package.json && git commit -a -m "Moving into mongodb-js org" && npm version patch && git push --tags && npm publish;
• find and replace -> mongodb-js in .git/config
• github api -> transfer repo to org
• update travis GH app to allow mongodb-js (fails silently)
• travis resync

See http://akshaykumar6.github.io/github-js/

Something like:

Let's discuss some open questions and ideas in this issue with the goal to create a guide for new contributions and migrations from existing private repos into mongodb-js.

I. All repos/projects under mongodb-js

1. What are the requirements for any repo inside mongodb-js?
   • a) Documentation
   • b) Tests
   • c) Code Coverage
   • d) Code Style / Conventions
   • e) npm (does every repo under mongodb-js need to be hosted on npm?)
2. Does it make sense to classify projects into different types? And how is the type stored and enforced? E.g.
   • CLI (a command line tool installable with npm)
   • SPA (single-page application running entirely on client)
   • Full Client/Server app
   • Utility (small helper functions and code snippets)
   • Non-App (specs, docs, guidelines, ...)
3. mj - a CLI app that helps manage and orchestrate mongodb-js
   • a) What features does it need?
   • b) Who writes it?
4. How do we handle combining/deduping functionality?

II. Migrating existing projects

1. What steps are required?
2. What can we automate?
3. How do we handle currently private projects?
4. How do we enforce requirements (see I.1)

III. Creating new projects under mongodb-js

1. How to create "hello world" scaffold app? --> use mj create
2. Have you ticked all the requirements boxes? --> use mj check
3. How to add to mongodb-js? --> use mj add