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

Add contributing subcommand #23

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

Conversation

kemitchell
Copy link
Member

@kennymalac
Copy link

Hey, I myself am not a Go programmer so I cannot comment on the code, though I will say it looks fine to me. I consider this a minor point: I noticed that the CONTRIBUTING file regex is hardcoded to write to that file, I was wondering if you would consider a flag for making the filename explicit (i.e. -filename blah.md). So for example I have a CONTRIBUTING.md file in Media Center that contains my Contributor's guide. I may call this ContributorsGuide.md or something to that effect; however, I do not know if all projects would necessarily want it appended into that file. Just a thought, I don't know if the other subcommands have that option to not hardcode the filename. I know for LICENSE it doesn't make much sense for that filename to be configurable, but perhaps here it does?

@kemitchell
Copy link
Member Author

Here is the text that the subcommand appends to CONTRIBUTING:

Licensing

If you submit a pull request, please be prepared to license your contributions under the terms of the Charity Public License, a modern evolution of licenses like MIT and the two-clause BSD license.

The code doesn't always write to CONTRIBUTING.md. Rather it looks for a CONTRIBUTING file, upper or lower case, with an extension or not, and appends to that file.

@kennymalac
Copy link

Well yes, I meant the CONTRIBUTING/contributing filename itself being hardcoded, not the extension of that file. I suppose it's fine that way, do you know if any project would want to deviate from that?

@kemitchell
Copy link
Member Author

@kennymalac I'm sure some may, but AFAIK, GitHub only "supports" CONTRIBUTING and variations in its UI.

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.

2 participants