6

I have MIT licensed code. There was a bug in this code and I fixed this bug - i.e. changed the originally licensed sources.

Is there any specific format I should use to specify what changes I made to this code?

Are there any good practices/examples of doing this?

| improve this question | |
  • How is the project managed? Is it on Github? Can you fork it, apply your changes and make a pull request? – Tim Malone Apr 29 '16 at 10:43
3

Please send bugfixes to the current maintainer.

Many maintainers have a FAQ that mentions their preferred format. For example:

  • the "unified diff" format -- the Linux Kernel a; b
  • the "unified diff" format -- OpenWrt c
  • the "unified diff" format -- Gimp d
  • the "unified diff" format -- FreeBSD e
  • the "unified diff" format -- Python f
  • etc.
| improve this answer | |
  • 1
    Hmm... I feel like this doesn't answer the question. It feels like those "link-only" answers - without the links, the answer provides little to no information that is actually helpful. Why don't you quote some one or two of these links, and retain the rest? – Zizouz212 Apr 3 '16 at 2:12
3

A secondary point- Please provide details of what you've done, and why This is covered in the links above, but nothing is worse than getting a patch through, that changes variable X to variable Y with no explanation.

Whilst you've probably spent time finding and fixing the bug, remember that whoever reviews your patch may well not know anything about it. Hence, a code lump with minimal or no documentation attached is a massive pain in the neck to deal with.

| improve this answer | |

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.