iai-group / guidelines Goto Github PK

Highlight Args indentation in IAI Python Style Guide

To use feature/#{id}-{first n words from issue title "-"-separated}

Add guidelines for external contributors to our public repositories (e.g., DialogueKit, UserSimCRS).

Using GitHub actions?

also flake8?

Including: flake8, black, setting up remote ssh to gustav1

Template:

• Python 3.9
• Using GitHub actions instead of CodeCov for unit tests; post only coverage summary "badge"
• Enforce that coverage cannot decrease

Repos to update: DialogueKit, UserSimCRS, MovieBot, trec-cast

Suggestion:

• Documentation: cite in references (add BibTeX format)
• Just a website/code/dataset: footnote, unless there is an associated paper (then both)

See also related DialogueKit issue: iai-group/DialogueKit#161

Add arxiv latex cleaner to the paper template.

1. Update environment.yaml with arxiv_latex_cleaner.
2. Create config for cleaning.

Very popular and configurable markdown linter available as a vscode extension.

When there are many imports in a Python file it is easy to lose track of the ordering. Flake8 does not consider ordering out of the box but it is in our styleguide.

Maybe we should consider adding flake8-import-order and reorder-python-imports for automatic ordering of imports (black does not do this at the moment)?

Specify which option to use for YAML config (server vs repo)

We should probably make a decision on requirements.txt and environment.yml. Maintaining both is not common practice and should not be necessary.

Use markdown guidelines as a template.

Make single-turn requests working using [ChitChat/FAQ feature]

Python functions and classes can be imported in 'init.py'. This allows for simplified importing from other modules.

There should be instructions on pre-commit hooks usage in this repository.

• One option is the ReviewNB GitHub tool
• Could VS Code 1.59 be used for that?

We'd need to add documentation on how to review Jupyter notebooks under guidelines/code review.

• template repo
• UserSimCRS
• arXiv conv assistant

Depends on #44

Candidates include "standards" and "best practices"

It is actually standard for journal titles to be abbreviated, even when there is no length limitation on the references (e.g., it is specifically required by Elsevier journals). Therefore, we should revert back to using abbreviations, and this is the reference for the list of standard word abbreviations: https://www.issn.org/services/online-services/access-to-the-ltwa/

Update both template-project and https://github.com/iai-group/guidelines/tree/main/python#local-development-configuration

Including filtering for own P0 issues and single-click branch creation.

Can you check how to make more user-friendly branch names (e.g., first 3 words or only issue number)?

Remove guidelines/python/example_script.py

Compare tensorboard, W&B, ...

Perhaps explain in the README (https://github.com/iai-group/template-project) the setup steps (code coverage, server-side tests, etc.)

Ideally, also generate locally the code coverage report (as txt).

• Add reference docstrings
• Add missing type annotations
• Add class example
• Simplify argparse (no need for named group...)

This would involve running black, flake8, mypy, docformatter, and redoing docstrings to follow Google doc-style.

Follow-up to issue #46

Codecov uses branch names in the URL requests. In order for Codecov to be able to produce reports, branches should not have # in them, since that messes up URLs.