ພາບລວມ
ໜ້ານີ້ກຳນົດແນວທາງຮູບແບບ (style guide) ສຳລັບ dtdocs ແລະ ຂໍ້ມູນກ່ຽວກັບວິທີ ການມີສ່ວນຮ່ວມໃນໂຄງການ.
ມັນຖືກລວມໄວ້ໃນຄູ່ມືຜູ້ໃຊ້ເພື່ອໃຫ້ເຈົ້າສາມາດເຫັນວິທີການສະແດງຜົນ ແລະ ວິທີການຂຽນ. ກະລຸນາໄປທີ່ GitHub ເພື່ອເບິ່ງຊອດໂຄດຂອງໜ້ານີ້.
ໂຄງສ້າງ ແລະ ເນື້ອຫາຂອງຄູ່ມືໄດ້ຖືກພິຈາລະນາຢ່າງລະອຽດໂດຍອີງຕາມເກນດັ່ງນີ້:
- ຄູ່ມືຄວນຈະຄົບຖ້ວນ – ມັນຄວນຈະອະທິບາຍທຸກຟັງຊັນທີ່ມີໃນ darktable
- ມັນຄວນມີໂຄງສ້າງທີ່ສອດຄ່ອງ ແລະ ເປັນເຫດເປັນຜົນ, ແລະ ທຸກໆຟັງຊັນຄວນມີບ່ອນຢູ່ທີ່ເໝາະສົມໃນໂຄງສ້າງນັ້ນ
- ມັນຄວນຈະຍາວເທົ່າທີ່ຈຳເປັນ ແຕ່ສັ້ນທີ່ສຸດເທົ່າທີ່ຈະເປັນໄປໄດ້ – ຄວາມກະຊັບແມ່ນສິ່ງສຳຄັນ
- ມັນຄວນຈະເປັນກາງ (objective)
- ຟັງຊັນຄວນຖືກອະທິບາຍພຽງຄັ້ງດຽວເທົ່ານັ້ນ (ຍົກເວັ້ນຄຳແນະນຳຂັ້ນຕອນການເຮັດວຽກພື້ນຖານໃນສ່ວນພາບລວມ)
- ຄວນໃສ່ຮູບພາບສະເພາະບ່ອນທີ່ຈຳເປັນເພື່ອຊ່ວຍໃຫ້ເຂົ້າໃຈຫຼັກການສຳຄັນເທົ່ານັ້ນ ແລະ ບໍ່ຄວນມີຂໍ້ຄວາມໃນຮູບ ຍົກເວັ້ນແຕ່ຫຼີກເວັ້ນບໍ່ໄດ້
ໂດຍທົ່ວໄປແລ້ວ ພວກເຮົາ ບໍ່ ສົນໃຈກ່ຽວກັບ:
- ການປັບປ່ຽນໂຄງສ້າງຄູ່ມືໃໝ່
- ການປ່ຽນພາສາ markup
- ບົດຮຽນສອນວິທີການເຮັດວຽກຢ່າງລະອຽດ (ແຕ່ພວກເຮົາສົນໃຈທີ່ຈະເຜີຍແຜ່ສິ່ງເຫຼົ່ານັ້ນໃນບລັອກຂອງ darktable.org ຫຼື pixls.us)
ພວກເຮົາ ສົນໃຈ ກ່ຽວກັບ
- ການແກ້ໄຂການສະກົດຄຳ ແລະ ໄວຍາກອນ
- ການປັບປຸງຂໍ້ຄວາມໃຫ້ແຈ້ງຂຶ້ນ
- ເອກະສານສຳລັບຟີເຈີໃໝ່
ພວກເຮົາມີຄວາມຍິນດີສະເໝີທີ່ຈະຮັບຟັງວ່າສ່ວນໃດຂອງຄູ່ມືທີ່ເຈົ້າອ່ານແລ້ວບໍ່ເຂົ້າໃຈ ແລະ ຍ້ອນຫຍັງ, ເພື່ອທີ່ພວກເຮົາຈະໄດ້ປັບປຸງເອກະສານໃຫ້ດີຂຶ້ນ.
ໂດຍທົ່ວໄປແລ້ວ, ຖ້າເຈົ້າຕ້ອງການປ່ຽນແປງຄັ້ງໃຫຍ່, ກະລຸນາເປີດ issue ແລະ ປຶກສາກັບຜູ້ເກັບຮັກສາລະບົບກ່ອນ. ສິ່ງນີ້ເພື່ອຫຼີກເວັ້ນການເຮັດວຽກທີ່ຈະບໍ່ຖືກຍອມຮັບ.
🔗ຮູບແບບການສົ່ງ (modality)
ວິທີທີ່ດີທີ່ສຸດແມ່ນການສ້າງ pull request. ເບິ່ງ workflow ສຳລັບຄຳແນະນຳລະອຽດເທື່ອລະຂັ້ນຕອນ.
ຖ້າເຈົ້າບໍ່ຮູ້ວ່າມັນແມ່ນຫຍັງ ຫຼື ບໍ່ສະດວກທີ່ຈະເຮັດ, ເຈົ້າສາມາດແນະນຳການປັບປຸງເລັກໆນ້ອຍໆ ໂດຍການເປີດ issue ໃໝ່ ໃນ github ໄດ້.