search

donejs / developer-relations

Developer Relations & Evangelism
MIT License
1 stars 0 forks source link

Add CONTRIBUTING.md #16

Open chasenlehara opened 7 years ago

chasenlehara commented 7 years ago

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:

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.

leoj3n commented 7 years ago

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

Contributing

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

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 commented 7 years ago

Assuming a lean, mean README like that:

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

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

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

image