Add CONTRIBUTING.md

[chasenlehara]

Add a CONTRIBUTING.md file to each repo that links to either the DoneJS contribution guide (coming soon!) or a more specific one (e.g. the CanJS contribution guide for a CanJS project).

If there’s already a contribution guide in a repo’s README, then move it to CONTRIBUTING.md and format it similarly to the DoneJS contribution guide.

Otherwise, you can use the DoneJS contribution guide as an outline for what should be included. You can look at related projects to see how their templates were customized and here are some example commits that show updating a project to meet these guidelines:

• donejs-firebase
• syn

Of course, if you’re unsure, please reach out to ask questions or open a PR anyway and we’ll fix it in the review process. Thank you for your help!

Below is a list of all the repos. Check off the repo once you’ve submitted a PR for it.

• https://github.com/bitovi/documentcss
• https://github.com/bitovi/documentjs
• https://github.com/bitovi/funcunit
• https://github.com/bitovi/jquerypp
• https://github.com/bitovi/syn
• https://github.com/bitovi/testee
• https://github.com/bitovi/testee-client
• https://github.com/canjs/bit-docs-html-canjs
• https://github.com/canjs/can-cid
• https://github.com/canjs/can-compile
• https://github.com/canjs/can-component
• https://github.com/canjs/can-compute
• https://github.com/canjs/can-connect
• https://github.com/canjs/can-connect-cloneable
• https://github.com/canjs/can-connect-feathers
• https://github.com/canjs/can-connect-signalr
• https://github.com/canjs/can-construct
• https://github.com/canjs/can-construct-proxy
• https://github.com/canjs/can-construct-super
• https://github.com/canjs/can-control
• https://github.com/canjs/can-control-plugin
• https://github.com/canjs/can-define
• https://github.com/canjs/can-define-backup
• https://github.com/canjs/can-define-lodash
• https://github.com/canjs/can-define-stream
• https://github.com/canjs/can-define-stream-kefir
• https://github.com/canjs/can-define-validate-validatejs
• https://github.com/canjs/can-ejs
• https://github.com/canjs/can-event
• https://github.com/canjs/can-fixture
• https://github.com/canjs/can-fixture-socket
• https://github.com/canjs/can-jquery
• https://github.com/canjs/can-legacy-view-helpers
• https://github.com/canjs/can-list
• https://github.com/canjs/can-list-sort
• https://github.com/canjs/can-map
• https://github.com/canjs/can-map-attributes
• https://github.com/canjs/can-map-backup
• https://github.com/canjs/can-map-define
• https://github.com/canjs/can-map-delegate
• https://github.com/canjs/can-map-lazy
• https://github.com/canjs/can-map-list
• https://github.com/canjs/can-map-setter
• https://github.com/canjs/can-map-validations
• https://github.com/canjs/can-model
• https://github.com/canjs/can-model-cached
• https://github.com/canjs/can-model-queue
• https://github.com/canjs/can-mustache
• https://github.com/canjs/can-namespace
• https://github.com/canjs/can-observation
• https://github.com/canjs/can-observe
• https://github.com/canjs/can-route
• https://github.com/canjs/can-route-pushstate
• https://github.com/canjs/can-set
• https://github.com/canjs/can-simple-dom
• https://github.com/canjs/can-simple-map
• https://github.com/canjs/can-stache
• https://github.com/canjs/can-stache-bindings
• https://github.com/canjs/can-stache-converters
• https://github.com/canjs/can-stream-kefir
• https://github.com/canjs/can-types
• https://github.com/canjs/can-validate
• https://github.com/canjs/can-validate-legacy
• https://github.com/canjs/can-validate-validatejs
• https://github.com/canjs/can-vdom
• https://github.com/canjs/can-view-autorender
• https://github.com/canjs/can-view-callbacks
• https://github.com/canjs/can-view-href
• https://github.com/canjs/can-view-import
• https://github.com/canjs/can-view-live
• https://github.com/canjs/can-view-model
• https://github.com/canjs/can-view-modifiers
• https://github.com/canjs/can-view-nodelist
• https://github.com/canjs/can-view-parser
• https://github.com/canjs/can-view-scope
• https://github.com/canjs/can-view-target
• https://github.com/canjs/can-util
• https://github.com/canjs/can-zone
• https://github.com/canjs/can-zone-storage
• https://github.com/canjs/canjs
• https://github.com/canjs/canjs-feathers
• https://github.com/canjs/react-view-models
• https://github.com/canjs/steal-stache
• https://github.com/donejs/autorender
• https://github.com/donejs/cli
• https://github.com/donejs/css
• https://github.com/donejs/deploy
• https://github.com/donejs/done-component
• https://github.com/donejs/done-serve
• https://github.com/donejs/done-ssr
• https://github.com/donejs/done-ssr-middleware
• https://github.com/donejs/donejs
• https://github.com/donejs/donejs-connect-model
• https://github.com/donejs/donejs-cordova
• https://github.com/donejs/donejs-documentjs
• https://github.com/donejs/donejs-electron
• https://github.com/donejs/donejs-feathers
• https://github.com/donejs/donejs-firebase
• https://github.com/donejs/donejs-jasmine
• https://github.com/donejs/donejs-jshint
• https://github.com/donejs/donejs-mocha
• https://github.com/donejs/donejs-nw
• https://github.com/donejs/donejs-react
• https://github.com/donejs/donejs-vagrant
• https://github.com/donejs/generator-donejs
• https://github.com/donejs/worker-autorender
• https://github.com/stealjs/cache-bust
• https://github.com/stealjs/es6-module-loader
• https://github.com/stealjs/grunt-steal
• https://github.com/stealjs/live-reload
• https://github.com/stealjs/platform
• https://github.com/stealjs/steal
• https://github.com/stealjs/steal-bundler
• https://github.com/stealjs/steal-conditional
• https://github.com/stealjs/steal-cordova
• https://github.com/stealjs/steal-css
• https://github.com/stealjs/steal-electron
• https://github.com/stealjs/steal-jasmine
• https://github.com/stealjs/steal-less
• https://github.com/stealjs/steal-mocha
• https://github.com/stealjs/steal-npm
• https://github.com/stealjs/steal-nw
• https://github.com/stealjs/steal-parse-amd
• https://github.com/stealjs/steal-react-jsx
• https://github.com/stealjs/steal-qunit
• https://github.com/stealjs/steal-sass
• https://github.com/stealjs/steal-socket.io
• https://github.com/stealjs/steal-svg
• https://github.com/stealjs/steal-tools
• https://github.com/stealjs/stealjs
• https://github.com/stealjs/system-json
• https://github.com/stealjs/transpile

[leoj3n]

Looking good! Although, in my opinion, all of this:

Contributing

Check out the contribution guide on DoneJS.com for information on:

• Code of Conduct
• Getting Help
• Project Organization
• Reporting Bugs
• Suggesting Features
• Finding Ways to Contribute
  • Finding open issues
  • Getting involved in the community
  • Spreading the word
• Developing Locally
  • Signing up for GitHub
  • Forking & cloning the repository
  • Installing the dependencies
  • Running the tests
  • Building the documentation
  • Viewing the site
• Changing the Code
  • Creating a new branch
  • Style guide
  • Updating the tests
  • Updating the documentation
  • Submitting a pull request
• Updating DoneJS.com
• Evangelism
  • Writing a blog article
  • Speaking at a conference or meetup
  • Organizing a DoneJS meetup

At the beginning of every repo's contributing guide is a bit distracting. Anyways, I think a simple link to the website would probably suffice, and require less maintenance when things change.

[leoj3n]

Assuming a lean, mean README like that:

---

• README.md
  • (intro and description)
  • Usage
    • Add to your package.json blah blah blah
  • Contributing
    • Link to CONTRIBUTING.md

---

My original thought was to have a multiple-file structure like that:

---

• CHANGELOG.md
  • Contains a link pointing to the GitHub releases tab for the repo.
• CONTRIBUTING.md
  • Link to http://donejs.com/contributing.html
    • Link to HACKING.md
    • Link to RELEASING.md
    • Link to LICENSE.md
• HACKING.md
  • Setup
  • Build
  • Test
• RELEASING.md
• LICENSE.md

---

However, after the contributors talked some sense into me, I think I'll shoot for that instead:

---

• README.md
  • Contributing
    • Link to the GitHub releases tab for the repo.
• CONTRIBUTING.md
  • Link to http://donejs.com/contributing.html
  • Developing Locally
    • Forking & cloning the repository
    • Installing the dependencies
    • Running the tests
• LICENSE.md

---

To be clear, CONTRIBUTING.md is the file GitHub suggests as "guidelines for contributing" when creating an issue: