Skip to content
This repository was archived by the owner on Feb 22, 2018. It is now read-only.

doc(CONTRIBUTING.md): updates #472

Closed
wants to merge 1 commit into from
Closed

Conversation

vicb
Copy link
Contributor

@vicb vicb commented Jan 30, 2014

No description provided.

@mhevery
Copy link
Contributor

mhevery commented Feb 4, 2014

MERGED: 294f965

@mhevery mhevery closed this Feb 4, 2014
@chalin
Copy link
Contributor

chalin commented Feb 5, 2014

Victor, Misko: thanks for this, it is helpful. Are there also "developer notes" somewhere to explain how to, e.g., setup one's environment, run tests, generate documentation? I have figured some things out, but it would be nice to take the guesswork out of it. E.g., is it normal to gets lots of hints and warnings output when generating the docs? I'd be willing to put something initial together (based on the limited knowledge I have) if nothing currently exists. If that would be helpful, then in what form? DEV-NOTES.md? Wiki page(s)?

@vicb
Copy link
Contributor Author

vicb commented Feb 6, 2014

IMO contributing.md could be a good fit and maybe a link to this file in the readme. I would prefer a file that could easily be updated while wiki pages tend to get outdated and not updated. It also nice to have everything in your code tree.

On 5 février 2014 19:09:39 CET, Patrice Chalin [email protected] wrote:

Victor, Misko: thanks for this, it is helpful. Are there also
"developer notes" somewhere to explain how to, e.g., setup one's
environment, run tests, generate documentation? I have figured some
things out, but it would be nice to take the guesswork out of it. E.g.,
is it normal to gets lots of hints and warnings output when generating
the docs? I'd be willing to put something initial together (based on
the limited knowledge I have) if nothing currently exists. If that
would be helpful, then in what form? DEV-NOTES.md? Wiki page(s)?


Reply to this email directly or view it on GitHub:
#472 (comment)

@mhevery
Copy link
Contributor

mhevery commented Feb 10, 2014

+1 for CONTRIBUTING.md. No there are no notes anywhere. If you write it up.
I will review it and provide feedback. Happy to answer any questions. Yes
dart2js produces a lot of errors. It is a known issues and we would like to
get that fixed.

On Thu, Feb 6, 2014 at 11:05 AM, Victor Berchet [email protected]:

IMO contributing.md could be a good fit and maybe a link to this file in
the readme. I would prefer a file that could easily be updated while wiki
pages tend to get outdated and not updated. It also nice to have everything
in your code tree.

On 5 février 2014 19:09:39 CET, Patrice Chalin [email protected]
wrote:

Victor, Misko: thanks for this, it is helpful. Are there also
"developer notes" somewhere to explain how to, e.g., setup one's
environment, run tests, generate documentation? I have figured some
things out, but it would be nice to take the guesswork out of it. E.g.,
is it normal to gets lots of hints and warnings output when generating
the docs? I'd be willing to put something initial together (based on
the limited knowledge I have) if nothing currently exists. If that
would be helpful, then in what form? DEV-NOTES.md? Wiki page(s)?


Reply to this email directly or view it on GitHub:
#472 (comment)


Reply to this email directly or view it on GitHubhttps://github.com//pull/472#issuecomment-34358153
.

@chalin
Copy link
Contributor

chalin commented Feb 11, 2014

A first cut has been submitted as #548. I'll be working on the scripts next while I await feedback concerning the document.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Development

Successfully merging this pull request may close these issues.

3 participants