Brute force Checklist.
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 20/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- markdown, python
- Área
- content, documentation
Línea de trabajo
Comienza revisando las páginas Markdown detrás de Documentation, ACE_contig_to_alignment y Getting_Started; después, compara su formato, ejemplos de Python/Biopython, enlaces, referencias y secciones RSS con esta lista de comprobación. Se considerará terminado cuando las páginas aplicables estén actualizadas, los enlaces y anclajes funcionen, los ejemplos cumplan las versiones indicadas de Python y Biopython, y las referencias o feeds incrustados se hayan reemplazado según lo sugerido.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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
- Lenguaje dominante
- CSS
- Estrellas
- 167
- Forks
- 379
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de biopython/biopython.github.io
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 48/100
biopython/biopython.github.io#117 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 35/100
biopython/biopython.github.io#98 · 3 comentarios ·
-
help wanted
Dificultad 3/5 1-2 días Aptitud para principiantes 42/100
biopython/biopython.github.io#85 · 2 comentarios ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 35/100
biopython/biopython.github.io#84 · 8 comentarios ·
-
Include build instructions in README so contributors can (easily) get a local Jekyll setup going Abiertohelp wanted
Dificultad 2/5 Medio día Aptitud para principiantes 42/100
biopython/biopython.github.io#79 · 6 comentarios ·
Todos los issues de biopython/biopython.github.io
Issues similares
-
[Bug] Header pattern can't find its navigation menu, and the menu needs a better default name Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Link Checker Report Abiertoautomated issue report
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
-
[Author] @scrapertweeter3-prog Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
shanselman/TinyToolTown#815 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
[SHOWCASE]: iritvik.com Abierto3 star needs images needs review showcase
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100