Checklist for submitting a patch to trac

asked 2014-08-20 08:17:58 +0100

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?

answered 2014-08-20 08:20:47 +0100

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)

run doctests (sage -t filename.py)
build and check documentation (sage -docbuild all html)
add your name to list of authors

edit flag offensive delete link

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 ( 2014-08-20 14:35:33 +0100 )edit

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

kcrisman ( 2014-08-20 14:35:56 +0100 )edit

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 ( 2014-08-20 15:01:08 +0100 )edit

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

KnS ( 2014-08-23 21:30:58 +0100 )edit

add a comment

Your Answer

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

Checklist for submitting a patch to trac

1 Answer

Comments

Your Answer

Question Tools

Stats

Related questions

Checklist for submitting a patch to trac edit

1 Answer

Comments

Your Answer

Question Tools

Stats

Related questions

Checklist for submitting a patch to trac