Permalink
Browse files

Introduce CONTRIBUTING.md file

  • Loading branch information...
1 parent 1b0fee4 commit 1f033d9505d5e0268bdd89558dba26fa21f2527c @janodvarko janodvarko committed Oct 2, 2012
Showing with 25 additions and 0 deletions.
  1. +25 −0 CONTRIBUTING.md
View
@@ -0,0 +1,25 @@
+Firebug Contributing Guidelines
+===============================
+*Web Development Evolved* [getfirebug.com](https://getfirebug.com)
+
+[Download](https://addons.mozilla.org/en-US/firefox/addon/firebug/)
+
+Guides
+------
+Pleae read following guides before contributing to the Firebug project.
+
+* [Firebug Source Structure](https://getfirebug.com/wiki/index.php/Source)
+* [Build Firebug XPI](https://getfirebug.com/wiki/index.php/Simple_Firebug_build)
+* [Hacking on Firebug](http://www.softwareishard.com/blog/firebug/hacking-on-firebug/)
+* [Firebug Coding Style](https://getfirebug.com/wiki/index.php/Firebug_Coding_Style)
+* [Firebug FAQ] https://getfirebug.com/wiki/index.php/FAQ
+
+Further Resources
+-----------------
+* Home: [https://getfirebug.com/](https://getfirebug.com/)
+* Blog: [https://blog.getfirebug.com/](https://blog.getfirebug.com/)
+* Twitter: [https://twitter.com/#!/firebugnews](https://twitter.com/#!/firebugnews)
+* Discussion Group: [https://groups.google.com/forum/?fromgroups#!forum/firebug](https://groups.google.com/forum/?fromgroups#!forum/firebug)
+* Wiki: [https://getfirebug.com/wiki](https://getfirebug.com/wiki/index.php/Main_Page)
+* Report an Issue: [http://code.google.com/p/fbug/issues/list](http://code.google.com/p/fbug/issues/list)
+* Firebug Extensions: [https://getfirebug.com/extensions](https://getfirebug.com/wiki/index.php/Firebug_Extensions)

2 comments on commit 1f033d9

Member

simonlindholm replied Oct 2, 2012

s/Pleae read following/Please read the following/, and the "Firebug FAQ" link has incorrect syntax.

I don't think we should demand that people read all of those links before contributing, they are mostly just hints about how to hack on Firebug. "Further Resources" and download link seems redundant given the README.

Really, if the README already contains (or links to) most of the information, and this is shown mostly just for pull requests, I think only the Code Style link, and something about testing (except please please fix issue 5610 before linking to FBTest) is relevant here.

Owner

janodvarko replied Oct 2, 2012

s/Pleae read following/Please read the following/, and the "Firebug FAQ" link has incorrect syntax.

Fixed, thanks

I don't think we should demand that people read all of those links before contributing,
they are mostly just hints about how to hack on Firebug.

Well, I have been repeating the basic steps/rules to new contributors so many times that
it would safe me a lot of time if folks would actually read it before contributing.

"Further Resources" and download
link seems redundant given the README.

Yes, but these are basic and important resources so, a bit of redundancy is not hurting.

Anyway, we can discuss at the call today.

Honza

Please sign in to comment.