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

docs: adds contributing guide and usage examples #38

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jpower432
Copy link
Member

@jpower432 jpower432 commented Jan 31, 2025

Description

Adds documentation updates as a follow-on to #36

How has this been tested?

N/A

Types of changes

  • Documentation (change which affects the documentation)

Quality assurance (all should be covered).

  • My code follows the style guidelines of this project
  • 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
  • New and existing tests pass locally with my changes
  • All commits are signed-off.

All information about development is moved to the
contributing guide and the README is updated with
high level information and usage examples.

Signed-off-by: Jennifer Power <[email protected]>
@jpower432 jpower432 force-pushed the docs/contributing-guide branch from 419ff1d to dd2b6de Compare February 14, 2025 20:06
@jpower432 jpower432 marked this pull request as ready for review February 14, 2025 20:06
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.

1 participant