comparison DOCS/tech/patches.txt @ 8556:ecff1745d189

Document things from the start. Inspired by a patch from Thomas Jarosch <tomj@simonv.com>.
author diego
date Tue, 24 Dec 2002 18:41:20 +0000
parents 7b6b7fb76965
children 61ba1af7d87b
comparison
equal deleted inserted replaced
8555:7bb2b7e8a4fd 8556:ecff1745d189
18 4. Read your patch. We'll *refuse* it if it changes indentation of the 18 4. Read your patch. We'll *refuse* it if it changes indentation of the
19 code or if it does tab/space conversion or other cosmetical changes! 19 code or if it does tab/space conversion or other cosmetical changes!
20 20
21 5. Comment parts that really need it (tricky side-effects etc). 21 5. Comment parts that really need it (tricky side-effects etc).
22 Commenting trivial code not required. Comments must be English! 22 Commenting trivial code not required. Comments must be English!
23
24 6. If you implement new features, add or change command line switches or modify
25 the behavior of existing features, please do not forget to also update the
26 documentation. The documentation maintainers will assist you in doing this.
23 27
24 6. Send your patch to the mplayer-dev-eng mailing list as a base64-encoded 28 7. Send your patch to the mplayer-dev-eng mailing list as a base64-encoded
25 attachment (use gzip or bzip2 *only* if it's bigger than 80k or if you know 29 attachment (use gzip or bzip2 *only* if it's bigger than 80k or if you know
26 that your mailer messes up (reformats) text attachments) with the subject 30 that your mailer messes up (reformats) text attachments) with the subject
27 line: '[PATCH] very short description of the patch'. 31 line: '[PATCH] very short description of the patch'.
28 In the mail, describe in a few sentences what you change and why. 32 In the mail, describe in a few sentences what you change and why.
29 If you made independent changes, try to send them as separate patches. 33 If you made independent changes, try to send them as separate patches.
35 developers on the list. We want you to be available for discussing your 39 developers on the list. We want you to be available for discussing your
36 code, you might be asked to make modifications before we accept it. Don't 40 code, you might be asked to make modifications before we accept it. Don't
37 worry, mplayer-dev-eng is not high traffic and you can subscribe with the 41 worry, mplayer-dev-eng is not high traffic and you can subscribe with the
38 nomail option if you do not wish to receive all the mails. 42 nomail option if you do not wish to receive all the mails.
39 43
40 7. Give us a few days to react. We try to review patches as fast as possible, 44 8. Give us a few days to react. We try to review patches as fast as possible,
41 but unfortunately we are constantly overloaded with work, be it MPlayer 45 but unfortunately we are constantly overloaded with work, be it MPlayer
42 related or from our day to day lives. If your patch seems to be ignored, 46 related or from our day to day lives. If your patch seems to be ignored,
43 please resend it and mention that you got ignored. We are interested in your 47 please resend it and mention that you got ignored. We are interested in your
44 work and will eventually either accept it or reject it with an explanation 48 work and will eventually either accept it or reject it with an explanation
45 what and why we disliked about your patch. 49 what and why we disliked about your patch.
46 50
47 8. Do not immediately ask for CVS write access. If you contributed one or more 51 9. Do not immediately ask for CVS write access. If you contributed one or more
48 nice, acceptable patches and they need maintaining or you want to be an 52 nice, acceptable patches and they need maintaining or you want to be an
49 MPlayer developer, you'll get CVS write access. 53 MPlayer developer, you'll get CVS write access.
50 54
51 Thank you! 55 Thank you!