Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit feaca46

Browse files
committed
update the contributing faq
svn path=/branches/v0_99_maint/; revision=7475
1 parent 905bfd7 commit feaca46

1 file changed

Lines changed: 25 additions & 1 deletion

File tree

doc/faq/howto_faq.rst

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -516,7 +516,31 @@ list.
516516

517517
If you have made lots of local changes and do not want to a diff
518518
against the entire tree, but rather against a single directory or
519-
file, that is fine, but we do prefer svn diffs against HEAD.
519+
file, that is fine, but we do prefer svn diffs against the top level
520+
(where setup.py lives) since it is nice to have a consistent way to
521+
apply them.
522+
523+
If you are posting a patch to fix a code bug, please explain your
524+
patch in words -- what was broken before and how you fixed it. Also,
525+
even if your patch is particularly simple, just a few lines or a
526+
single function replacement, we encourage people to submit svn diffs
527+
against HEAD or the branch they are patching. It just makes life
528+
simpler for us, since we (fortunately) get a lot of contributions, and
529+
want to receive them in a standard format. If possible, for any
530+
non-trivial change, please include a complete, free-standing example
531+
that the developers can run unmodified which shows the undesired
532+
behavior pre-patch and the desired behavior post-patch, with a clear
533+
verbal description of what to look for. The original developer may
534+
have written the function you are working on years ago, and may no
535+
longer be with the project, so it is quite possible you are the world
536+
expert on the code you are patching and we want to hear as much detail
537+
as you can offer.
538+
539+
When emailing your patch and examples, feel free to paste any code
540+
into the text of the message, indeed we encourage it, but also attach
541+
the patches and examples since many email clients screw up the
542+
formatting of plain text, and we spend lots of needless time trying to
543+
reformat the code to make it usable.
520544

521545
You should check out the guide to developing matplotlib to make sure
522546
your patch abides by our coding conventions

0 commit comments

Comments
 (0)