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.

Sign up for GitHub

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

Jump to bottom

Docs: Harmonize README with template #4957

Open
medubelko opened this issue Aug 9, 2024 · 1 comment
Open

Docs: Harmonize README with template #4957

medubelko opened this issue Aug 9, 2024 · 1 comment
Labels
enhancement New features or optimizations triaged

Comments

@medubelko
Copy link
Contributor

What needs to get done

The README is incomplete, and we should be harmonizing all of them across craft projects.

For now, we can rewrite it using the template in canonical/starbase#233, and leave the build section blank while @sergiusens polishes it.

Depends on canonical/starbase#233.

Why it needs to get done

Improves contributor documentation.
@lengau lengau added enhancement New features or optimizations triaged labels Aug 9, 2024
@syncronize-issues-to-jira Syncronize issues to Jira
Copy link

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/CRAFT-3196.

This message was autogenerated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New features or optimizations triaged
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@lengau @medubelko