Contributing

[pfiller]

@kenearley @stof Please share your feedback liberally.

This adds a contributing.md file which makes it clear what is expected of people opening pull requests and issues in the Chosen repository. I've used a lightly modified version of @necolas's excellent issue-guidelines because I think they're great. My sincere hope is that these guidelines will help us receive better issues and more concise pull requests to Chosen.

It is probably easier to review this document in the browser than anywhere else. But do what works for you.

[pfiller]

@tjschuck I'd welcome your feedback and grammar policing as well.

[stof]

you don't need this IMO. Github creates anchors for all titles (it will be #bug-reports here)

[necolas]

The issue with doing that is that if the title changes, so do the url hashes. I reverted to using explicit named anchors to ensure the urls don't change when the title copy does.

[pfiller]

I didn't know GitHub did that, @stof - thanks for the heads up. I like @necolas's point about keeping the anchors, though. I'll probably leave them as it gives people an easy search and replace target.

[kenearley]

Would there be any benefit by putting this in the Wiki? One benefit, I believe, is that you can set permissions for updating the wiki separate from the repo.

If we plan to never use the Wiki, I say let's turn it off.

[stof]

the benefit of putting it in the CONTRIBUTING.md file of the repo is that github will tell people about it when they open a PR with a link to read it. If it is in the wiki, it will be even less likely to get read than in the readme.

[kenearley]

@stof Ah! Good to know. Pretty cool.

[pfiller]

I turned the Wiki off since I doubt we'll ever use that.

[tjschuck]

the maintainers workload should be possessive: the maintainers' workload.

[tjschuck]

Took me a minute to even find the issue search. We should link to it: https://github.com/harvesthq/chosen/search?type=Issues

[pfiller]

I've gone ahead and merged this after updating with @tjschuck's grammar notes. This can serve as a living document so if you see something that bothers you, speak up.

@necolas Thanks for providing an excellent starting point. I'd love to share some of our changes with your repo if you're interested. Should I just start a PR with the things we've changed or is there some other procedure you'd prefer?