feat: add gen-contrib script for generating CONTRIBUTING.md documents#23
Merged
NucciTheBoss merged 2 commits intocharmed-hpc:mainfrom Jul 11, 2025
Conversation
The `gen-contrib` script accepts several flags for quickly generating a repository's CONTRIBUTING.md guide. Signed-off-by: Jason C. Nucciarone <nuccitheboss@ubuntu.com>
NucciTheBoss
requested review from
dsloanm and
jedel1043
and removed request for
a team
AshleyCliff
requested changes
Jul 11, 2025
Contributor
AshleyCliff
left a comment
AshleyCliff
left a comment
There was a problem hiding this comment.
Looks great and should help a ton! Just one wording suggestion and one question about adding GH Discussions.
Signed-off-by: Jason C. Nucciarone <nuccitheboss@ubuntu.com>
Member
Author
|
@AshleyCliff ready for round 2 electric boogalo |
Contributor
|
Looks good to me! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pre-submission checklist
Summary of changes
This PR adds the
gen-contribscript for quickly generating per-repo CONTRIBUTING.md documents. To generate a simple project CONTRIBUTING.md document, all you need to do is run the following command:To add further information such as general contributing information, or steps that you need to follow before opening a new PR on the repository, you can pass additional content via the command-line:
To save the CONTRIBUTING.md file generated by
gen-contrib, you can either redirect the stdout of the script to a file, or pass the--outputflag:./gen-contrib --repo slurm-charms --license apache-2.0 > CONTRIBUTING.mdor
Related Issues, PRs, and Discussions
This script is related to our ongoing work to update our community documentation. After this PR is merged, the script will be used to update our repositorys' CONTRIBUTING.md files to point to the organization-wide CONTRIBUTING.md file.
Docs
Or:
This script does not introduce a user facing change, and is primarily meant to be used by Charmed HPC project developers for quickly creating new CONTRIBUTING.md documents.