Opened 12 years ago

Closed 12 years ago

Last modified 10 years ago

#8108 closed enhancement (fixed)

Expand the Sage Developer Guide for newcomers

Reported by: rbeezer Owned by: mvngu
Priority: major Milestone: sage-4.3.2
Component: documentation Keywords:
Cc: mvngu, leif Merged in: sage-4.3.2.rc0
Authors: Rob Beezer, Minh Van Nguyen Reviewers: Ross Kyprianou, John Palmieri
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description

Newcomers to Sage development could use more comprehensive guidance on getting started.

A rough draft of possible new content is attached to this ticket.

Attachments (3)

how-to-develop.txt (10.8 KB) - added by rbeezer 12 years ago.
trac_8108-beginner-guide.patch (18.8 KB) - added by mvngu 12 years ago.
based on Sage 4.3.2.alpha0
trac_8108-typos.patch (1.3 KB) - added by jhpalmieri 12 years ago.
apply on top of other patch

Download all attachments as: .zip

Change History (15)

Changed 12 years ago by rbeezer

comment:1 Changed 12 years ago by rbeezer

  • Cc mvngu added

Changed 12 years ago by mvngu

based on Sage 4.3.2.alpha0

comment:2 Changed 12 years ago by mvngu

  • Authors set to Rob Beezer, Minh Van Nguyen
  • Milestone changed from sage-wishlist to sage-4.3.2
  • Status changed from new to needs_review

I have attached a patch that includes information from how-to-develop.txt. I also added more stuff, which means I can no longer review Rob's work. What's missing is a section on patch management using Mercurial queue. That could be for a separate ticket if necessary.

comment:3 Changed 12 years ago by leif

  • Cc leif added

Thanks (also for disclosing Gauss' e-mail address).

comment:4 follow-up: Changed 12 years ago by rossk

  • Status changed from needs_review to positive_review

This will save newbie developers (and reviewers) hours of work (includes me! :-) For what its worth, Ive read it and it has answered a dozen questions. Thanks. We should remember that any other info can be included over time. Given this stuff is so valuable IMHO and Ive already tried much of what Ive read (but now it makes sense ;-) Im going to give this a positive review, if I may, even if you guys want to finesse it before including it. AGAIN THANKS!

comment:5 Changed 12 years ago by jhpalmieri

Here's a little patch to fix a few typos.

Changed 12 years ago by jhpalmieri

apply on top of other patch

comment:6 Changed 12 years ago by rbeezer

John - thanks for the fixes (and the once-over).

John's fixes look good to me. Minh handled the formatting (and lots more), so hopefully this will pass for a review of John's changes. ;-)

Rob

comment:7 in reply to: ↑ 4 ; follow-up: Changed 12 years ago by rbeezer

Ross,

Thanks for the enthusiastic review! I've included you as a cc on #8147 that will expand the material on Mercurial queues at the end.

Rob

Replying to rossk:

This will save newbie developers (and reviewers) hours of work (includes me! :-) For what its worth, Ive read it and it has answered a dozen questions. Thanks. We should remember that any other info can be included over time. Given this stuff is so valuable IMHO and Ive already tried much of what Ive read (but now it makes sense ;-) Im going to give this a positive review, if I may, even if you guys want to finesse it before including it. AGAIN THANKS!

comment:8 Changed 12 years ago by mvngu

  • Merged in set to sage-4.3.2.rc0
  • Resolution set to fixed
  • Reviewers set to Ross Kyprianou, John Palmieri
  • Status changed from positive_review to closed

comment:9 in reply to: ↑ 7 Changed 12 years ago by rossk

Replying to rbeezer:

Ross,

Thanks for the enthusiastic review! I've included you as a cc on #8147 that will expand the material on Mercurial queues at the end.

Rob

No probs Rob :-)

comment:10 follow-up: Changed 11 years ago by pdehaye

  • Authors changed from Rob Beezer, Minh Van Nguyen to Rob Beezer, Minh Van Nguyen, Ross Kyprianou, John Palmieri , leif

Thanks to all for this and subsequent patches. It's a great improvement from what was there before. I know because I sweat hard a long time ago, which put me off from more sage development for a while. I just tried my hand at it again and it now makes _much_ more sense.

comment:11 Changed 11 years ago by pdehaye

  • Authors changed from Rob Beezer, Minh Van Nguyen, Ross Kyprianou, John Palmieri , leif to Rob Beezer, Minh Van Nguyen

comment:12 in reply to: ↑ 10 Changed 10 years ago by rbeezer

Replying to pdehaye:

Thanks to all for this and subsequent patches.

pdehaye - thanks for the feedback. I'm sitting on a pile of further suggestions for refinements, which I should whip into shape soon.

Rob

Note: See TracTickets for help on using tickets.