Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a CONTRIBUTING.md file to let users know how to contribute to Piwik #5381

Closed
mattab opened this issue Jun 25, 2014 · 1 comment
Closed
Assignees
Labels
Major Indicates the severity or impact or benefit of an issue is much higher than normal but not critical. Task Indicates an issue is neither a feature nor a bug and it's purely a "technical" change.
Milestone

Comments

@mattab
Copy link
Member

mattab commented Jun 25, 2014

Oftentimes open source projects place a CONTRIBUTING file in the root directory. It explains how a participant should do things like format code, test fixes, and submit patches. Here is a fine example from puppet and another one from factory_girl_rails. From a maintainer's point of view, the document succinctly communicates how best to collaborate. And for a contributor, one quick check of this file verifies their submission follows the maintainer's guidelines.

https://github.com/blog/1184-contributing-guidelines

sample: https://raw.githubusercontent.com/contribute-md/contribute-md-template/master/contribute.md

puppet example: https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md

Let's create this file for Piwik as well!

The information can be found here: http://developer.piwik.org/guides/contributing-to-piwik-core

Maybe we link to this file, or we copy paste a summary of it in the CONTRIBUTING?

@mattab mattab added this to the 2.5.0 - Piwik 2.5.0 milestone Jul 8, 2014
tsteur added a commit that referenced this issue Jul 22, 2014
@tsteur
Copy link
Member

tsteur commented Jul 22, 2014

I linked to the guide. Copy/paste never works ;) One will be outdated for sure.

@tsteur tsteur self-assigned this Jul 22, 2014
@tsteur tsteur closed this as completed Jul 22, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Major Indicates the severity or impact or benefit of an issue is much higher than normal but not critical. Task Indicates an issue is neither a feature nor a bug and it's purely a "technical" change.
Projects
None yet
Development

No branches or pull requests

2 participants