Skip to content

Missing CI #10

@Existency

Description

@Existency

Right now, the project doesn't have any sort of CI implemented.
This allowed at least one bug to pass unnoticed, which can be seen on #9, that completely broke an entire feature.

I propose the creation of a basic CI, where cargo-test, cargo-fmt and clippy are used to make sure no unwanted change goes through.

I have a semi working example of it on my fork of the repo.
Furthermore, I've found some issues while implementing this, which I'll list below, for further discussion on what should be done about this. If necessary, I'll open issues regarding each of them.

  • Available tests can't be used with github actions as we don't have a monitor.
  • Low test coverage.
  • No guidelines to format the code. (I'm using rustfmt in my example which reformatted nearly the entire project when ran)
  • Not checking whether features work before pushing them to main branch (I've used clippy both as a linter and to check whether the project's features work. Ideally this would be somewhere else, such as cargo test).

If these changes are deemed necessary by @Rintse I may continue working on my fork to at least fix the doctests then PR it here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions