Skip to content
This repository has been archived by the owner. It is now read-only.

Add CONTRIBUTING.md and Changelog #55

Closed
bnjmnt4n opened this issue Mar 18, 2014 · 9 comments

Comments

2 participants
@bnjmnt4n
Copy link
Member

commented Mar 18, 2014

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

@ghost

This comment has been minimized.

Copy link

commented Mar 28, 2014

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

This comment has been minimized.

Copy link
Member Author

commented Mar 29, 2014

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

This comment has been minimized.

Copy link

commented Apr 10, 2014

+1 Either CHANGELOG.md or Releases tab please

@bnjmnt4n

This comment has been minimized.

Copy link
Member Author

commented Apr 10, 2014

Ok, I'll add a CHANGELOG.md

@bnjmnt4n

This comment has been minimized.

Copy link
Member Author

commented Apr 15, 2014

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.

@bnjmnt4n bnjmnt4n closed this Apr 15, 2014

@tomByrer

This comment has been minimized.

Copy link

commented Apr 15, 2014

cheers

@bnjmnt4n

This comment has been minimized.

Copy link
Member Author

commented Dec 23, 2014

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

@ghost

This comment has been minimized.

Copy link

commented Dec 23, 2014

@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

This comment has been minimized.

Copy link
Member Author

commented Dec 24, 2014

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

@bnjmnt4n bnjmnt4n reopened this Dec 24, 2014

@ghost ghost closed this in e9ec3a6 Dec 24, 2014

This issue was closed.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
You can’t perform that action at this time.