Brute force Checklist.
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 20/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- markdown, python
- Ambito
- content, documentation
Direzione di ricerca
Inizia esaminando le pagine Markdown alla base di Documentation, ACE_contig_to_alignment e Getting_Started, quindi confronta la loro formattazione, gli esempi Python/Biopython, i link, i riferimenti e le sezioni RSS con questa checklist. Il lavoro è completo quando le pagine interessate sono aggiornate, i link e le ancore funzionano, gli esempi soddisfano le versioni indicate di Python e Biopython e i riferimenti o feed incorporati sono sostituiti come suggerito.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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
- Lingua principale
- CSS
- Stelle
- 167
- Fork
- 379
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di biopython/biopython.github.io
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 48/100
biopython/biopython.github.io#117 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 35/100
biopython/biopython.github.io#98 · 3 commenti ·
-
help wanted
Difficoltà 3/5 1-2 giorni Idoneità per principianti 42/100
biopython/biopython.github.io#85 · 2 commenti ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 35/100
biopython/biopython.github.io#84 · 8 commenti ·
-
Include build instructions in README so contributors can (easily) get a local Jekyll setup going Apertahelp wanted
Difficoltà 2/5 Mezza giornata Idoneità per principianti 42/100
biopython/biopython.github.io#79 · 6 commenti ·
Tutte le issue di biopython/biopython.github.io
Issue simili
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 75/100
railmapgen/rmp-gallery#4068 ·
-
edit event needs review
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
processing/processing-community-day#268 · 1 commento ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
digitalfabrik/integreat-cms#4574 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
ubilabs/esa-climate-from-space#2555 ·
-
token request
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
Uniswap/default-token-list#2587 ·