Brute force Checklist.
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 20/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Cần làm rõ
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- markdown, python
- Lĩnh vực
- content, documentation
Hướng nghiên cứu
Bắt đầu bằng cách xem xét các trang Markdown đứng sau Documentation, ACE_contig_to_alignment và Getting_Started, sau đó so sánh định dạng, các ví dụ Python/Biopython, liên kết, tài liệu tham khảo và các phần RSS của chúng với danh sách kiểm tra này. Công việc được xem là hoàn tất khi các trang áp dụng đã được cập nhật, các liên kết và anchor hoạt động, các ví dụ đáp ứng các phiên bản Python và Biopython đã nêu, và các tài liệu tham khảo hoặc feed được nhúng đã được thay thế như đề xuất.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
As suggested by Markus Piotrowski
Checklist:
- Title
- The title in the markdown file may be changed into something more user-friendly (https://github.com/biopython/biopython.github.io/issues/22)
- Take care that the title is not repeated in the main text (like here: http://biopython.org/wiki/Documentation)
- Is the text up-to-date? (Python versions etc)
- Formatting
- Suggestion: Python/Biopython commands, keywords, module/function names should be formatted as inline-code with single backticks, e.g.
Bio.SeqIO??? Or bold??? - If applicable, they can also serve as links to the respective Wiki page
- Code output and command-line examples should be formatted as block code with three backticks instead of several single line inline-code statements.
- Check block code for trailing white spaces, which may result in the addition of an (unnecessary) horizontal scrollbars as here: http://biopython.org/wiki/ACE_contig_to_alignment.
- Code
- Code should be checked for a minimum of PEP8 compliance.
- The code should work (as it is) under Biopython 1.66
- Since we are recommending Python 3.5 as environment, the code should work under Python 3.5 ???
- Links
- Check all links
- 'Repair' broken links
Try to find a link that's more likely to be stable. E.g. for papers I think that dx.doi.org references (or Pubmed references) are more stable than linking to a special page of the respective journal or private or institutional homepages. With http://www.crossref.org/SimpleTextQuery/ you can do a reverse doi lookup for a given paper. - Links with anchors (.../some_page#jump_here) may have issues with upper/lowercase formatting (https://github.com/biopython/biopython.github.io/issues/13)
- Are the links up-to-date? E.g. in http://biopython.org/wiki/Getting_Started the Python Quick Reference links to Python 2.5
- References
- Some pages used a PubMed plugin under MediaWiki to display references (https://github.com/biopython/biopython.github.io/issues/12). Since it's unlikely (?) to have a functional replacement, I would suggest to convert them to simple links.
- RSS feeds
- As above, embedding an existing RSS feed seems hard (https://github.com/biopython/biopython.github.io/issues/4), again I would suggest replace with a link pointing to the RSS feed
- Ngôn ngữ chính
- CSS
- Star
- 167
- Fork
- 379
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của biopython/biopython.github.io
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 48/100
biopython/biopython.github.io#117 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 35/100
biopython/biopython.github.io#98 · 3 bình luận ·
-
help wanted
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 42/100
biopython/biopython.github.io#85 · 2 bình luận ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 35/100
biopython/biopython.github.io#84 · 8 bình luận ·
-
Include build instructions in README so contributors can (easily) get a local Jekyll setup going Đang mởhelp wanted
Độ khó 2/5 Nửa ngày Mức phù hợp với người mới 42/100
biopython/biopython.github.io#79 · 6 bình luận ·
Tất cả issue của biopython/biopython.github.io
Issue tương tự
-
[Bug] Header pattern can't find its navigation menu, and the menu needs a better default name Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
-
Link Checker Report Đang mởautomated issue report
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
-
[Author] @scrapertweeter3-prog Đang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
shanselman/TinyToolTown#815 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
-
[SHOWCASE]: iritvik.com Đang mở3 star needs images needs review showcase
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100