JSOSolvers.jl icon indicating copy to clipboard operation
JSOSolvers.jl copied to clipboard

Apply COPIERTemplate

Open abelsiqueira opened this issue 2 years ago • 2 comments

The jury is still out on what features will be added in the COPIERTemplate, and it should be easy to switch if we want to create a specific JSOTemplate.

Main features:

  1. Adds several linter and formatters through pre-commit, and their configuration files. If the user installs pre-commit (and they should), this will run before the commit is completed, possibly fixing formatting, and complaining about linter issues. The same linters are run online in the CI.
  2. Fixes issues found by these linters (mostly MD files).
  3. Breaks CI.yml into Test.yml and Docs.yml, to allow for selective runs.
  4. Adds documentation for contributors (contributing.md) and for developer setup (developer.md).
  5. Adds a CITATION.cff and remove .zenodo.json

Some of these changes had to be manually assisted, but the vast majority was done simply by applying the template.

abelsiqueira avatar Sep 29 '23 13:09 abelsiqueira

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 88.49%. Comparing base (3cca9d5) to head (c49ca24). Report is 35 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #242   +/-   ##
=======================================
  Coverage   88.49%   88.49%           
=======================================
  Files           7        7           
  Lines        1026     1026           
=======================================
  Hits          908      908           
  Misses        118      118           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Sep 29 '23 13:09 codecov[bot]

Package name latest stable
FletcherPenaltySolver.jl
Percival.jl

github-actions[bot] avatar Sep 29 '23 13:09 github-actions[bot]

This will be superseded by BestieTemplate

tmigot avatar Oct 07 '24 22:10 tmigot