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: add README files #1

Merged
merged 2 commits into from
Nov 26, 2024
Merged

docs: add README files #1

merged 2 commits into from
Nov 26, 2024

Conversation

K-Beicher
Copy link
Collaborator

@K-Beicher K-Beicher commented Nov 26, 2024

Description

This PR set up the initial folder structure and completes the first readme files.

Closes seedcase-project/data#24

This PR needs a quick review.

I'm probably missing a few things in the README files. Feel free to provide bullet points on what should also be included.

Checklist

  • Ran spell-check
  • Formatted Markdown

set up folders and write the first draft of the three main readme files
Copy link
Member

@lwjohnst86 lwjohnst86 left a comment

Choose a reason for hiding this comment

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

Technically, the Conventional Commits type would be docs, not feat. Or chore since you are also adding empty scripts.

examples/free-living-birds/README.md Outdated Show resolved Hide resolved
examples/male-seed-beetle/README.md Outdated Show resolved Hide resolved
@K-Beicher K-Beicher changed the title feat: write readme files docs: write readme files Nov 26, 2024
@K-Beicher K-Beicher requested a review from lwjohnst86 November 26, 2024 10:01
@lwjohnst86 lwjohnst86 changed the title docs: write readme files docs: add README files Nov 26, 2024
@lwjohnst86 lwjohnst86 merged commit a484664 into main Nov 26, 2024
@lwjohnst86 lwjohnst86 deleted the feature/1/readme-files branch November 26, 2024 11:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Brainstorm how example data usage repos will look like, e.g. folders and files
2 participants