contribute.txt 2.6 KB

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