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

[RFE] Include support for displaying contents of the CONTRIBUTING.md file #1410

Open
pmatulis opened this issue Oct 7, 2022 · 0 comments
Open

[RFE] Include support for displaying contents of the CONTRIBUTING.md file #1410

pmatulis opened this issue Oct 7, 2022 · 0 comments

Comments

@pmatulis
Copy link

pmatulis commented Oct 7, 2022 •
edited
Loading

The charmcraft tool has as a by-product of the charm build process the file CONTRIBUTING.md. This file should be taken into account when displaying information in the Charmhub. It would inform viewers on how to contribute to the charm.

The template used for README.md includes a section pointing to CONTRIBUTING.md but I think that's a subpar solution. A link can be included alongside the existing Homepage and Submit a bug links for this (called Contributing for instance).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pmatulis