Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update begginer's guide #915

Merged
merged 2 commits into from
Nov 4, 2024

Conversation

kaelyndunnell
Copy link
Contributor

…a git account is not needed for latest updates of the code.

Proposed changes

Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.

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

Checklist

  • Black formatted
  • Unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

…a git account is not needed for latest updates of the code.
@kaelyndunnell
Copy link
Contributor Author

Fixes issue #839

@RemDelaporteMathurin RemDelaporteMathurin changed the title Updated What do I need to Know section of user guide to reflect that … Update begginer's guide Nov 4, 2024
@RemDelaporteMathurin RemDelaporteMathurin linked an issue Nov 4, 2024 that may be closed by this pull request
Copy link
Collaborator

@RemDelaporteMathurin RemDelaporteMathurin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @kaelyndunnell for this! I pushed one commit to:

  • avoid using my personal fork link (RemDelaporteMathurin) instad of festim-dev
  • use the direct reference to the section instead of a URL. That's because if we look at a version of the docs that is not stable (say fenicsx) then this link will always get to the stable version of the docs.

@RemDelaporteMathurin RemDelaporteMathurin merged commit a9d8980 into festim-dev:main Nov 4, 2024
3 of 4 checks passed
Copy link

codecov bot commented Nov 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.55%. Comparing base (6ec0543) to head (ebc3168).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #915   +/-   ##
=======================================
  Coverage   99.55%   99.55%           
=======================================
  Files          60       60           
  Lines        2717     2717           
=======================================
  Hits         2705     2705           
  Misses         12       12           

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation: Improve "What do I need to know" section
2 participants