Details for contribution workflow

[RemDelaporteMathurin]

Proposed changes

This just adds a few steps to the contribution workflow.

Types of changes

What types of changes does your code introduce to FESTIM?

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Code refactoring
• Documentation Update (if none of the other choices apply)
• New tests

[jhdark]

This is certainly an improvement from what was there previously. However, as much as I understand that technically you don't need a fenics environment to contribute, I still think we should mention this, and that one should run tests locally before asking for a review etc.

[RemDelaporteMathurin]

and that one should run tests locally before asking for a review etc.

Well in that case, you need an environment to contribute

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.63%. Comparing base (31864c8) to head (80ff56d).
Report is 72 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #865      +/-   ##
==========================================
+ Coverage   99.55%   99.63%   +0.07%     
==========================================
  Files          61       61              
  Lines        2724     2990     +266     
==========================================
+ Hits         2712     2979     +267     
+ Misses         12       11       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.