1109790 - Consolidate CONTRIBUTING.md and README.md

Status: RESOLVED INVALID

(Webtools Graveyard :: Air Mozilla, defect, P2)

Description

[Peter Bengtsson [:peterbe]]

At the moment, https://github.com/mozilla/airmozilla/blob/master/CONTRIBUTING.md has some information about contributing. 
For no good reason (bug author's fault) there's also lots of information in the https://github.com/mozilla/airmozilla/blob/master/README.md#how-to-contribute about this. 

The information in the README is more up to date. It should be consolidated. 

Perhaps the best approach is to move ALL documentation about the code/coding to the docs/ directory and publish that on readthedocs and point to it from CONTRIBUTING.md and README.md accordingly.

Comment 1

[vanrao1]

Dear Bengtsson,
I have been trying to contribute to air mozilla from long time.I'd like to take up a bug and work on it.
Since I have gone through README.md,CONTRIBUTING.md seemed unnecessary when README.md existed.
Could you please guide me how to start with this.

Comment 2

[Peter Bengtsson [:peterbe]]

This is probably an easier bug to get started with
https://bugzilla.mozilla.org/show_bug.cgi?id=1179452

You'll need to get a working environment set up on your computer. See the README for instructions
https://github.com/mozilla/airmozilla/blob/master/README.md

Comment 3

[vanrao1]

https://github.com/mozilla/airmozilla/commit/b0c7fbc3c3524472afefe121fcca79e9c9cd37af
I updated README.md by consolidating CONTRIBUTING.md.CONTRIBUTING.md is no more needed.Is this fine?

Comment 4

[vanrao1]

(In reply to Peter Bengtsson [:peterbe] from comment #2)
> This is probably an easier bug to get started with
> https://bugzilla.mozilla.org/show_bug.cgi?id=1179452
> 
> You'll need to get a working environment set up on your computer. See the
> README for instructions
> https://github.com/mozilla/airmozilla/blob/master/README.md

Thank you,Mr.Bengtsson.Will work on the bug.

Comment 5

[Andy Kochendorfer]

Platform deprecated.