Skip to content

Commit

Permalink
doc: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
squillero committed Jun 18, 2024
1 parent 91c2cd5 commit 298ec83
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ Test programs [do not need](https://evolution.berkeley.edu/) to be designed, but
* Byron is currently in [alpha](https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha) and under active development
* The default branch is always the more stable
* Do not clone experimental branches `exp/*` unless you really know what you are doing
* Follow this [style guide](https://github.com/squillero/style/blob/master/python.md) and keep the code formatted with [Ruff formatter](https://docs.astral.sh/ruff/formatter/)
* Follow this [style guide](https://github.com/squillero/style/blob/master/python.md) and keep the code formatted with [Ruff](https://docs.astral.sh/ruff/formatter/)
* Follow this [convention](https://github.com/squillero/style/blob/master/git.md) when drafting commit messages
* Write as few lines of code and as many lines of comments as possible (ie. use builtins, exploit generators and list comprehension)
* Be [paranoid](https://cad-polito-it.github.io/byron/paranoia) (cit. *"I need someone to show me the things"*)
* Use [pytest](https://docs.pytest.org/) and [Coverage.py](https://coverage.readthedocs.io/) for unit testing (ie. `coverage run --module pytest --all`)
* Use [Ruff](https://docs.astral.sh/ruff/linter/) for linting and [mypy](https://mypy-lang.org/) for additional type checking
* Use [Ruff](https://docs.astral.sh/ruff/linter/) for linting and [mypy](https://mypy-lang.org/) for type checking
* Use [direnv](https://direnv.net) to patch environment variables
* And remember that it may be wise to contact [Giovanni](https://github.com/squillero) before trying to change anything

Expand Down

0 comments on commit 298ec83

Please sign in to comment.