Brute force Checklist.
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 20/100
- Issue 類型
- 文件
- 描述清晰度
- 需要釐清
- 活躍度
- 停滯
- 技術堆疊
- markdown, python
- 領域
- content, documentation
研究方向
首先查看 Documentation、ACE_contig_to_alignment 和 Getting_Started 背後的 Markdown 頁面，然後根據此檢查清單比較它們的格式、Python/Biopython 範例、連結、參考資料和 RSS 區段。以下情況表示完成：適用頁面是最新的，連結和錨點可以正常運作，範例符合所述的 Python 和 Biopython 版本，且嵌入的參考資料或 feed 已依建議替換。
由索引模型根據 Issue 內容生成。
描述
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
- 主要語言
- CSS
- 星號
- 167
- 分支
- 378
- PR 合併指標
- 30 天內沒有已合併 PR
環境準備
這個專案沒有提供開發容器、Dockerfile 或貢獻指南，環境需要你自己搭建：先看它的 README，通用步驟見我們的新手貢獻指南。
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
biopython/biopython.github.io 的其他 Issue
-
難度 2/5 1-3 小時 新手友好度 48/100
biopython/biopython.github.io#117 ·
-
難度 2/5 1-3 小時 新手友好度 35/100
biopython/biopython.github.io#98 · 3 則留言 ·
-
help wanted
難度 3/5 1-2 天 新手友好度 42/100
biopython/biopython.github.io#85 · 2 則留言 ·
-
難度 2/5 1-3 小時 新手友好度 35/100
biopython/biopython.github.io#84 · 8 則留言 ·
-
Include build instructions in README so contributors can (easily) get a local Jekyll setup going未關閉help wanted
難度 2/5 半天 新手友好度 42/100
biopython/biopython.github.io#79 · 6 則留言 ·
查看 biopython/biopython.github.io 的全部 Issue
相似的 Issue
-
approved check:passed streams:add
難度 1/5 1 小時以內 新手友好度 75/100
維護者通常 1 天內回覆
-
feedback simulation workshop
難度 2/5 1-3 小時 新手友好度 78/100
githubnext/gh-aw-workshop#4456 ·
維護者通常 1 天內回覆
-
sync-en
難度 2/5 1-3 小時 新手友好度 72/100
維護者通常 1 天內回覆
-
[辞書] 誕おめ未關閉要トリアージ 辞書
難度 1/5 1 小時以內 新手友好度 85/100
維護者通常 1 天內回覆
-
難度 1/5 1-3 小時 新手友好度 75/100
douglascrockford/Misty#35 ·
維護者通常 1 天內回覆