search

bestiejs / json3

A JSON polyfill. No longer maintained.
https://bestiejs.github.io/json3
Other
1.02k stars 150 forks source link

Add CONTRIBUTING.md and Changelog #55

Closed bnjmnt4n closed 9 years ago

bnjmnt4n commented 10 years ago

@kitcambridge Do you think we need a CONTRIBUTING.md and a changelog? I can create them if needed.

ghost commented 10 years ago

Sure, that'd be great. I know other projects have used GitHub's releases tab for tracking changes, but a simple CHANGELOG.md works equally well. I'm also not too picky on coding guidelines...if a pull request is solid, I'll just merge it and fix the style nits afterward.

bnjmnt4n commented 10 years ago

I was thinking about using the Wiki to create the changelog, like Lo-Dash and other BestieJS projects. Also, for the CONTRIBUTING.md, I just intended to copy the Contributing section of the readme and a few style guidelines, as GitHub automatically links to CONTRIBUTING.md, allowing it to be displayed more conveniently when creating issues/PRs.

tomByrer commented 10 years ago

+1 Either CHANGELOG.md or Releases tab please

bnjmnt4n commented 10 years ago

Ok, I'll add a CHANGELOG.md

bnjmnt4n commented 10 years ago

I've already added a CHANGELOG.md and a CONTRIBUTING.md. I will update the CHANGELOG.md to include details for the latest JSON3 version, 3.3.1, soon.

tomByrer commented 10 years ago

cheers

bnjmnt4n commented 9 years ago

@kitcambridge do you think you can help to finish the CONTRIBUTING.md file?

ghost commented 9 years ago

@d10 Sure; I'll copy over the "contributing" section from the read me, and add a primer on how to add and run tests. I'm not picky about coding style (and jsfmt looks interesting for automatically fixing up style nits)—maybe just a short note on following the conventions already in the code. What do you think?

bnjmnt4n commented 9 years ago

Sure. Also if you’re free please help to finish CHANGELOG.md. Thanks! ;)