Create a CONTRIBUTING.md for Broadleaf #498

Merged
merged 7 commits into from Nov 8, 2013

Conversation

Projects
None yet
2 participants
Owner

phillipuniverse commented Nov 5, 2013

This will automatically be available to users that open new issues: https://github.com/blog/1184-contributing-guidelines

@ghost ghost assigned phillipuniverse Nov 5, 2013

Owner

bpolster commented on c5f6353 Nov 5, 2013

TODO: Discuss changes to documentation / demo
TODO: Discuss forum versus issues
TODO: Discuss trivial changes versus larger changes (and need for Apache 2 contributor agreement)
TODO: Discuss information required for adding an issue (steps to recreate, stack trace, version the problem was encountered on - (need to try on latest patch release of the version, screen shots, etc)
TODO: Add additional resources (getting started, etc.)
TODO: Better description of community versus enterprise

(see https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md) which has good ideas on several of the above TODOs

Owner

phillipuniverse commented Nov 5, 2013

@bpolster I don't think I captured most of the TODOs that you listed there but they all sound good to me. FYI, you can read the CONTRIBUTING doc better by going to https://github.com/BroadleafCommerce/BroadleafCommerce/blob/contributing/CONTRIBUTING.md

Owner

phillipuniverse commented Nov 5, 2013

Ansible also has a good CONTRIBUTING doc: https://github.com/ansible/ansible/blob/devel/CONTRIBUTING.md

Owner

phillipuniverse commented Nov 7, 2013

@bpolster I'm pretty happy with the state that it's in here. Would like to get this merged in prior to the 3.0.4 GA release so that it will show up on the master branch (and incidentally all the new issue reports) ASAP.

BTW, some of the things you pointed out in your TODO might already be covered (or more suitable for) the general README in the root of the project: https://github.com/BroadleafCommerce/BroadleafCommerce/blob/master/README.md

bpolster added a commit that referenced this pull request Nov 8, 2013

Merge pull request #498 from BroadleafCommerce/contributing
Create a CONTRIBUTING.md for Broadleaf

@bpolster bpolster merged commit f08988d into BroadleafCommerce-3.0.x Nov 8, 2013

Owner

phillipuniverse commented Nov 8, 2013

@bpolster FYI, after a pull request like this is merged you can hit that blue 'Delete branch' button. I just did it, but for your future reference.

@phillipuniverse phillipuniverse deleted the contributing branch Nov 8, 2013

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment