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

fix: README #5

Merged
merged 2 commits into from
Sep 15, 2023
Merged

fix: README #5

merged 2 commits into from
Sep 15, 2023

Conversation

ambarrio
Copy link
Contributor

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes initial README

Type of change

Please delete options that are not relevant.

  • Documentation changes

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Test Configuration:

  • Firmware version:
  • Hardware:
  • Toolchain:
  • SDK:

PR checklist:

  • This comment contains a description of changes (with reason).
  • My code follows the style guidelines of this project
  • Make sure your code lints, is well-formatted and type checks
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • If you've added a new stage - have you followed the pipeline CLI conventions in the USAGE guide
  • README.md is updated
  • If a new tool or package is included, update poetry.lock, the conda recipe and cited it properly
  • Include any new authors/contributors
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and documentation and corrected any misspellings
  • If you are doing a release, or a significant change to the code, update CHANGELOG.md

@fbdtemme fbdtemme merged commit 5b3741a into dev Sep 15, 2023
11 checks passed
@fbdtemme fbdtemme deleted the chore/fix-README branch September 15, 2023 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants