add contributing file in the root dir #1726

Merged
merged 1 commit into from Oct 7, 2012

Projects

None yet

5 participants

@andreia
andreia commented Sep 18, 2012

How about adding a CONTRIBUTING.md file?

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

@wouterj
Member
wouterj commented Sep 18, 2012

Maybe it is better to put the contribution/documentation/overview.rst document as CONTRUTING file.

@richardmiller

Linking to the relevant contribution section of the documentation on symfony.com was the decision made for symfony itself.

@stof stof commented on the diff Sep 18, 2012
CONTRIBUTING.md
@@ -0,0 +1,9 @@
+Contributing
+------------
+
+>**Note**
+>Unless you're documenting a feature that's new to Symfony 2.1, all pull
@stof
stof Sep 18, 2012 Symfony member

This is not enough anymore. the master branch is now for 2.2 and 2.1 also has its branch

@wouterj
Member
wouterj commented Sep 18, 2012

@richardmiller well, maybe we need to change that decision. I think most of the contributors, unless you are a core contributor, don't read the overview file. We get lots of errors and unneeded comments in PR's because they didn't read the file.

I think more people will read it if you place it in the README/CONTRIBUTORS file.

@weaverryan
Member

I really like this idea, but I also agree that this should be very simple - just like: https://github.com/symfony/symfony/blob/master/CONTRIBUTING.md

So let's simplify this a bit. But I love it - I think that people do tend to know to look for a CONTRIBUTING file and I also like that the docs follow the example set by the core code.

Thanks!

@andreia
andreia commented Sep 25, 2012

Something like this:

Contributing

We love contributors! If you'd like to contribute to the Symfony documentation, please read the Contributing to the Documentation section.

@weaverryan weaverryan merged commit 25ffc71 into symfony:2.0 Oct 7, 2012
@weaverryan weaverryan added a commit that referenced this pull request Oct 7, 2012
@weaverryan weaverryan [#1726] Tweaking CONTRIBUTING doc 68d7843
@weaverryan
Member

Hey guys!

Yep, I like what we have here - I've merged in the PR and just removed the top paragraph.

Thanks!

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