Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Brute force Checklist.

Aberta
  • Algo errado?
#38 2 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
20/100
Tipo de issue
Documentação
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
markdown, python
Domínio
content, documentation

Direção de pesquisa

Comece revisando as páginas Markdown por trás de Documentation, ACE_contig_to_alignment e Getting_Started e, em seguida, compare a formatação, os exemplos de Python/Biopython, os links, as referências e as seções RSS delas com esta lista de verificação. A tarefa estará concluída quando as páginas aplicáveis estiverem atualizadas, os links e âncoras funcionarem, os exemplos atenderem às versões especificadas de Python e Biopython e as referências ou feeds incorporados forem substituídos conforme sugerido.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

help wanted

As suggested by Markus Piotrowski
Checklist:

  1. Title
  1. Is the text up-to-date? (Python versions etc)
  2. Formatting
  3. Suggestion: Python/Biopython commands, keywords, module/function names should be formatted as inline-code with single backticks, e.g. Bio.SeqIO ??? Or bold???
  4. If applicable, they can also serve as links to the respective Wiki page
  5. Code output and command-line examples should be formatted as block code with three backticks instead of several single line inline-code statements.
  6. 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.
  7. Code
  8. Code should be checked for a minimum of PEP8 compliance.
  9. The code should work (as it is) under Biopython 1.66
  10. Since we are recommending Python 3.5 as environment, the code should work under Python 3.5 ???
  11. Links
  12. Check all links
  13. '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.
  14. Links with anchors (.../some_page#jump_here) may have issues with upper/lowercase formatting (https://github.com/biopython/biopython.github.io/issues/13)
  15. Are the links up-to-date? E.g. in http://biopython.org/wiki/Getting_Started the Python Quick Reference links to Python 2.5
  16. References
  17. 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.
  18. RSS feeds
  19. 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
Linguagem predominante
CSS
Estrelas
167
Forks
379
Nenhum PR com merge em 30d

Preparar o ambiente

Ainda não verificamos os arquivos de configuração deste projeto. Comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de biopython/biopython.github.io

Todas as issues de biopython/biopython.github.io

Issues semelhantes

Mais issues de Content

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.