We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ตอนนี้มีไฟล์คำอธิบายโครงการอยู่เยอะมาก และหลายไฟล์ไม่อัปเดต หรือไม่แน่ใจว่าใช้อันไหนเป็นอันล่าสุด จึงขอเสนอให้ยุบรวมไฟล์ย่อยๆ หรือที่มีเนื้อหาใกล้กัน ให้มาอยู่ด้วยกัน เพื่อการปรับปรุงที่สะดวกขึ้น และเพื่อให้ผู้ใช้ไม่สับสน
กลุ่มนี้น่าจะเหลือไฟล์เดียวได้เลย โดยเสนอให้เลือกลบ LICENSE.txt และคง LICENSE ไว้ เนื่องจากเป็นไฟล์ที่ GitHub อ่านออก (มีแสดง panel สรุปสัญญาอนุญาตให้)
กลุ่มนี้เข้าใจว่าที่มี 3 ไฟล์ เพราะบางอันใช้กับ PyPI บางอันใช้กับ GitHub แต่ในทางปฏิบัติ หากต้องการรวมเป็นไฟล์เดียว เราสามารถตั้งค่าใน setup.py ไปที่ชื่อไฟล์ที่เราต้องการได้
เสนอให้รวมเป็นไฟล์เดียว
กลุ่มนี้ จริงๆ แล้วแต่ละไฟล์มีเนื้อหาต่างกัน แต่เนื่องจากไฟล์มีขนาดเล็ก และเนื้อหาเกี่ยวเนื่องกัน จึงเสนอให้รวมเป็นไฟล์เดียวเพื่อความสะดวกในการดูแลรักษา และผู้ใช้สามารถเห็นเนื้อหาที่เกี่ยวข้องทั้งหมดพร้อมกันในคราวเดียว
โดยเสนอให้ในไฟล์ใหม่ แบ่งเป็น 3 หัวข้อ คือ
หากเห็นด้วยกับแนวทางการรวมนี้ (ไม่จำเป็นต้องรวมทุกกลุ่ม) ผมยินดีจะรวมให้ครับ แต่ก่อนลงมือ ขอปรึกษาว่า ไฟล์ที่รวมกัน อยากให้ฟอร์แมตไหน RST หรือ Markdown ครับ
ดูเปรียบเทียบ 2 ฟอร์แมตนี้ได้ที่
(รวมๆ คือ Markdown เรียบง่ายกว่า ส่วน RST มีส่วนขยายที่เหมาะกับการเขียน technical document มากกว่า)
The text was updated successfully, but these errors were encountered:
ขอตอบในส่วนแต่ละกลุ่มไฟล์นะครับ
กลุ่มที่ 1: ไฟล์ LICENSE เห็นด้วยครับ เพราะเหมือนว่า GitHub จะอ่านจากไฟล์ LICENSE อย่างเดียวนะครับ
กลุ่มที่ 2: ไฟล์ README
อันนี้ตอนแรกมีเพียงไฟล์ README.rst กับ README.md ต่อมาผมแยกไฟล์ README-pythainlp.md ออกจากไฟล์ README.md เพื่อนำไปแสดงผลใน pypi ส่วน README.md เป็นไฟล์หน้าหลักสำหรับแสดงแนะนำโครงการใน GitHub เพราะใน GitHub branche ตั้งต้นเป็น dev เป็นเวชั่นใหม่ที่กำลังพัฒนา ซึ่งไม่ใช่เวชั่นสำหรับใช้งานจริงครับ
ผมคิดว่าควรจะลบไฟล์ README.rst ทิ้ง และเปลี่ยนชื่อไฟล์ README-pythainlp.md -> README-pypi.md เพื่อลดความสับสนครับ
กลุ่มที่ 3: ไฟล์ CONTRIBUTORS
เห็นด้วยครับ
ส่วนการรวม ผมคิดว่าควรจะเลือกฟอร์แมต Markdown ครับ เน้นความเรียบง่ายเป็นหลักครับ
Sorry, something went wrong.
จะลองทำตามที่แนะนำครับ ขอบคุณครับ
No branches or pull requests
ตอนนี้มีไฟล์คำอธิบายโครงการอยู่เยอะมาก และหลายไฟล์ไม่อัปเดต หรือไม่แน่ใจว่าใช้อันไหนเป็นอันล่าสุด
จึงขอเสนอให้ยุบรวมไฟล์ย่อยๆ หรือที่มีเนื้อหาใกล้กัน ให้มาอยู่ด้วยกัน เพื่อการปรับปรุงที่สะดวกขึ้น และเพื่อให้ผู้ใช้ไม่สับสน
กลุ่มที่ 1: ไฟล์ LICENSE
กลุ่มนี้น่าจะเหลือไฟล์เดียวได้เลย โดยเสนอให้เลือกลบ LICENSE.txt และคง LICENSE ไว้ เนื่องจากเป็นไฟล์ที่ GitHub อ่านออก (มีแสดง panel สรุปสัญญาอนุญาตให้)
กลุ่มที่ 2: ไฟล์ README
กลุ่มนี้เข้าใจว่าที่มี 3 ไฟล์ เพราะบางอันใช้กับ PyPI บางอันใช้กับ GitHub
แต่ในทางปฏิบัติ หากต้องการรวมเป็นไฟล์เดียว เราสามารถตั้งค่าใน setup.py ไปที่ชื่อไฟล์ที่เราต้องการได้
เสนอให้รวมเป็นไฟล์เดียว
กลุ่มที่ 3: ไฟล์ CONTRIBUTORS
กลุ่มนี้ จริงๆ แล้วแต่ละไฟล์มีเนื้อหาต่างกัน แต่เนื่องจากไฟล์มีขนาดเล็ก และเนื้อหาเกี่ยวเนื่องกัน
จึงเสนอให้รวมเป็นไฟล์เดียวเพื่อความสะดวกในการดูแลรักษา และผู้ใช้สามารถเห็นเนื้อหาที่เกี่ยวข้องทั้งหมดพร้อมกันในคราวเดียว
โดยเสนอให้ในไฟล์ใหม่ แบ่งเป็น 3 หัวข้อ คือ
การรวม
หากเห็นด้วยกับแนวทางการรวมนี้ (ไม่จำเป็นต้องรวมทุกกลุ่ม) ผมยินดีจะรวมให้ครับ แต่ก่อนลงมือ ขอปรึกษาว่า ไฟล์ที่รวมกัน อยากให้ฟอร์แมตไหน RST หรือ Markdown ครับ
ดูเปรียบเทียบ 2 ฟอร์แมตนี้ได้ที่
(รวมๆ คือ Markdown เรียบง่ายกว่า ส่วน RST มีส่วนขยายที่เหมาะกับการเขียน technical document มากกว่า)
The text was updated successfully, but these errors were encountered: