[Messages] add a README file

RESOLVED FIXED

Status

Firefox OS
Gaia::SMS
RESOLVED FIXED
4 years ago
4 years ago

People

(Reporter: julienw, Assigned: julienw)

Tracking

Firefox Tracking Flags

(Not tracked)

Details

Attachments

(2 attachments)

(Assignee)

Description

4 years ago
The README file should explain the basic steps to contribute to the Messages application.
(Assignee)

Comment 1

4 years ago
Created attachment 8504794 [details] [review]
github PR

See https://github.com/julienw/gaia/blob/1082618-sms-readme/apps/sms/README.md for the formated file.
Assignee: nobody → felash
Attachment #8504794 - Flags: review?(schung)
Comment on attachment 8504794 [details] [review]
github PR

I think the information in this document is clear for debugging with Nightly. Only some few comments and nit on github, and some thoughts here:

- Should we also provide a link about how to debug with web IDE(app manager)?
- How to create a bug with clear and sufficient(log, image, video or even database) information? I think it's also a good way for contribution.
Attachment #8504794 - Flags: review?(schung)
(Assignee)

Comment 3

4 years ago
Comment on attachment 8504794 [details] [review]
github PR

Hey Steve,

I at last updated the README according to your comments!

I think we can make the part about Mulet better but we can maybe iterate from this in a separate bug?

I also added some troubleshooting information in [1], these are issues I saw on various computers during a hackathon, and I think it's better to have it on MDN than in the README :)

[1] https://developer.mozilla.org/en-US/Firefox_OS/Developing_Gaia/Running_the_Gaia_codebase
Attachment #8504794 - Flags: review?(schung)
Comment on attachment 8504794 [details] [review]
github PR

That a details and helpful intro for developer :) Only one nit on github(hope my grammar is correct).
Attachment #8504794 - Flags: review?(schung) → review+
(Assignee)

Comment 5

4 years ago
Hey Chris, would you have the time to do a proof reading on https://github.com/julienw/gaia/blob/1082618-sms-readme/apps/sms/README.md ?

You can comment directly in https://github.com/mozilla-b2g/gaia/pull/25141/files

Also tell me if some parts could be more suitable for MDN than here? I tried to add some things in MDN as part of this bug already.

Thanks !
Flags: needinfo?(cmills)
I've included my comments at https://github.com/mozilla-b2g/gaia/pull/25141 as requested.

I've also done a full copy edit of the README; see attached to this bug in an .md file.
Flags: needinfo?(cmills)
Created attachment 8544639 [details]
messages_readme_CE_chris_mills.md
(Assignee)

Comment 8

4 years ago
landed in 17cd52956a545a8ef604a76f816b4ddb3e336802

Thanks all !
Status: NEW → RESOLVED
Last Resolved: 4 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.