contribute.txt 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. // -*- mode:doc; -*-
  2. // vim: set syntax=asciidoc:
  3. Contributing to OpenADK
  4. =======================
  5. If you want to contribute to OpenADK, you will need a git view of
  6. the project. Refer to xref:getting-openadk[] to get it.
  7. You can either subscribe to the mailing list dev@openadk.org or
  8. send an email directly to wbx@openadk.org.
  9. [[submitting-patches]]
  10. Submitting patches
  11. ------------------
  12. When your changes are done, and committed in your local git view,
  13. _rebase_ your development branch on top of the upstream tree before
  14. generating the patch set. To do so, run:
  15. ---------------------
  16. $ git fetch --all --tags
  17. $ git rebase origin/master
  18. ---------------------
  19. Here, you are ready to generate then submit your patch set.
  20. To generate it, run:
  21. ---------------------
  22. $ git format-patch -M -n -s origin/master
  23. ---------------------
  24. This will generate patch files automatically adding the +Signed-off-by+ line.
  25. Once patch files are generated, you can review/edit the commit message
  26. before submitting them using your favorite text editor.
  27. Lastly, send/submit your patch set to the OpenADK developers:
  28. ---------------------
  29. $ git send-email --to dev@openadk.org *.patch
  30. ---------------------
  31. Note that +git+ should be configured to use your mail account.
  32. To configure +git+, see +man git-send-email+ or google it.
  33. Make sure posted *patches are not line-wrapped*, otherwise they cannot
  34. easily be applied. In such a case, fix your e-mail client, or better,
  35. use +git send-email+ to send your patches.
  36. Cover letter
  37. ~~~~~~~~~~~~
  38. If you want to present the whole patch set in a separate mail, add
  39. +--cover-letter+ to the +git format-patch+ command (see +man
  40. git-format-patch+ for further information). This will generate a
  41. template for an introduction e-mail to your patch series.
  42. A 'cover letter' may be useful to introduce the changes you propose
  43. in the following cases:
  44. * large number of commits in the series;
  45. * deep impact of the changes in the rest of the project;
  46. * RFC footnote:[RFC: (Request for comments) change proposal];
  47. * whenever you feel it will help presenting your work, your choices,
  48. the review process, etc.
  49. [[reporting-bugs]]
  50. Reporting issues/bugs, get help
  51. -------------------------------
  52. Try to think as if you were trying to help someone else; in
  53. that case, what would you need?
  54. Here is a short list of details to provide in such case:
  55. * host machine (OS/release)
  56. * git version of OpenADK
  57. * target for which the build fails
  58. * package(s) which the build fails
  59. * the command that fails and its output
  60. * the make.log file, generated when make v is used
  61. * any information you think that may be relevant
  62. Additionally, you can add the +.config+ file.