You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

58 lines
2.1 KiB

  1. guidelines for xed
  2. ====================
  3. xed source code is maintained using the git version control system
  4. and is available at the following location:
  6. Please don't commit directly to the git repository unless
  7. you have been given the green light to commit freely to xed.
  8. When in doubt assume you haven't ;-).
  9. Please attach patches in GitHub.
  10. If the patch fixes a bug that is not reported yet or is
  11. an enhancement, create a new bugreport.
  12. If you are a translator feel free to mark strings for translation,
  13. fix typos in the code, etc.
  14. Please send patches for build & configure fixes too. I really appreciate
  15. your help, I just want to review these fixes before applying.
  16. If you are a "build sheriff", feel free to commit fixes for build and
  17. configure (please, send me an e-mail with the patch you have applied).
  18. When committing to the xed git repository make sure to include a
  19. meaningful commit message. Changes without a sufficient commit message
  20. will be reverted. Commit messages should have the following format:
  21. === begin example commit ===
  22. Short explanation of the commit
  23. Longer explanation explaining exactly what's changed, whether any
  24. external or private interfaces changed, what bugs were fixed (with bug
  25. tracker reference if applicable) and so forth. Be concise but not too brief.
  26. === end example commit ===
  27. - Always add a brief description of the commit to the _first_ line of
  28. the commit and terminate by two newlines (it will work without the
  29. second newline, but that is not nice for the interfaces).
  30. - First line (the brief description) must only be one sentence and
  31. should start with a capital letter unless it starts with a lowercase
  32. symbol or identifier. Don't use a trailing period either. Don't exceed
  33. 72 characters.
  34. - The main description (the body) is normal prose and should use normal
  35. punctuation and capital letters where appropriate. Normally, for patches
  36. sent to a mailing list it's copied from there.
  37. - When committing code on behalf of others use the --author option, e.g.
  38. git commit -a --author "Joe Coder <>" and --signoff.
  39. Thanks,
  40. The xed team.