Ask Your Question
2

Checklist for submitting a patch to trac

asked 2014-08-20 01:17:58 -0500

this post is marked as community wiki

This post is a wiki. Anyone with karma >750 is welcome to improve it.

I would like to create a checklist that one should go through before submitting a patch to the trac server:

What are the points to be checked before submitting a patch to the trac server?

edit retag flag offensive close merge delete

1 answer

Sort by ยป oldest newest most voted
0

answered 2014-08-20 01:20:47 -0500

this post is marked as community wiki

This post is a wiki. Anyone with karma >750 is welcome to improve it.

This answer is community wiki; please add your points here (please provide commands/links on how to do this)

  1. run doctests (sage -t filename.py)
  2. build and check documentation (sage -docbuild all html)
  3. add your name to list of authors
edit flag offensive delete link more

Comments

I'd run doctests for all files unless it is very clear it only touches a certain file/directory. Probably running long doctests isn't a bad idea too, though that is more annoying with the patchbots apparently not working.

kcrisman gravatar imagekcrisman ( 2014-08-20 07:35:33 -0500 )edit

Similarly, documentation only needs to be checked if there is something that changed in doc...

kcrisman gravatar imagekcrisman ( 2014-08-20 07:35:56 -0500 )edit
2

On the other hand, I have been bitten by failing doctests inside RST files that could only be tested by 'make ptestlong', so that's what is the best answer. Let me add to the list item #0: write a doctest for every computation path that you change/add.

rws gravatar imagerws ( 2014-08-20 08:01:08 -0500 )edit

I would also suggesting building the pdf manual too. I have been bitten by this quite a few times.

KnS gravatar imageKnS ( 2014-08-23 14:30:58 -0500 )edit

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

Question Tools

1 follower

Stats

Asked: 2014-08-20 01:17:58 -0500

Seen: 141 times

Last updated: Aug 20 '14