Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .JuliaFormatter.toml

This file was deleted.

5 changes: 0 additions & 5 deletions .all-contributorsrc

This file was deleted.

12 changes: 0 additions & 12 deletions .copier-answers.yml

This file was deleted.

10 changes: 0 additions & 10 deletions .editorconfig

This file was deleted.

13 changes: 0 additions & 13 deletions .markdownlint.json

This file was deleted.

49 changes: 0 additions & 49 deletions .pre-commit-config.yaml

This file was deleted.

2 changes: 0 additions & 2 deletions .yamllint.yml

This file was deleted.

5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,10 @@
[![Build Status](https://github.com/lazarusA/UnpackSinTiles.jl/workflows/Test/badge.svg)](https://github.com/lazarusA/UnpackSinTiles.jl/actions)
[![Test workflow status](https://github.com/lazarusA/UnpackSinTiles.jl/actions/workflows/Test.yml/badge.svg?branch=main)](https://github.com/lazarusA/UnpackSinTiles.jl/actions/workflows/Test.yml?query=branch%3Amain)
[![Docs workflow Status](https://github.com/lazarusA/UnpackSinTiles.jl/actions/workflows/Docs.yml/badge.svg?branch=main)](https://github.com/lazarusA/UnpackSinTiles.jl/actions/workflows/Docs.yml?query=branch%3Amain)

[![Coverage](https://codecov.io/gh/lazarusA/UnpackSinTiles.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/lazarusA/UnpackSinTiles.jl)
<!-- [![DOI](https://zenodo.org/badge/DOI/FIXME)](https://doi.org/FIXME) -->
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
[![All Contributors](https://img.shields.io/github/all-contributors/lazarusA/UnpackSinTiles.jl?labelColor=5e1ec7&color=c0ffee&style=flat-square)](#contributors)

<!-- [![DOI](https://zenodo.org/badge/DOI/FIXME)](https://doi.org/FIXME) -->

## How to Cite

Expand Down
37 changes: 0 additions & 37 deletions docs/src/91-developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,43 +23,6 @@ If this is the first time you work with this repository, follow the instructions
This will ensure that you have two remotes in your git: `origin` and `upstream`.
You will create branches and push to `origin`, and you will fetch and update your local `main` branch from `upstream`.

## Linting and formatting

Install a plugin on your editor to use [EditorConfig](https://editorconfig.org).
This will ensure that your editor is configured with important formatting settings.


We use [https://pre-commit.com](https://pre-commit.com) to run the linters and formatters.
In particular, the Julia code is formatted using [JuliaFormatter.jl](https://github.com/domluna/JuliaFormatter.jl), so please install it globally first:

```julia-repl
julia> # Press ]
pkg> activate
pkg> add JuliaFormatter
```

To install `pre-commit`, we recommend using [pipx](https://pipx.pypa.io) as follows:

```bash
# Install pipx following the link
pipx install pre-commit
```

With `pre-commit` installed, activate it as a pre-commit hook:

```bash
pre-commit install
```

To run the linting and formatting manually, enter the command below:

```bash
pre-commit run -a
```

**Now, you can only commit if all the pre-commit tests pass**.


## Testing

As with most Julia packages, you can just open Julia in the repository folder, activate the environment, and run `test`:
Expand Down
11 changes: 0 additions & 11 deletions lychee.toml

This file was deleted.

Loading