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

feat: get contribute section from README #22

Closed
wants to merge 1 commit into from

Conversation

RichardLitt
Copy link
Member

This should grab the Contribute heading and section from the README, if it exists, and use it instead of the fixtures Contribute.

We want to do the same with the license, later - if there is no license file, but there's a section in the README, add the license. Likewise for vice versa.

Related to #12.

@wooorm
Copy link
Collaborator

wooorm commented Nov 14, 2017

@RichardLitt So you’re saying that, if there’s no CONTRIBUTING.md, we should grab the contents of the section if it’s in the README.md, and place it in CONTRIBUTING.md?

...and the same for LICENSE in the future?

Is there an example of a thing I could use as inspiration, that adds a file if it isn’t already there?

@RichardLitt
Copy link
Member Author

Yep! That's exactly what I am saying. We can probably grab the SPDX and fill in the license, too.

Build a space does this already, adding a file if it isn't there. Look for community checkers - the code should be relatively straightforward to read.

wooorm added a commit that referenced this pull request Nov 15, 2017
Previously, if there was no `CONTRIBUTE.md` file, the fixture in this
repo was used.  Now, in this case, and if there’s a `Contribute`
section on the README of the repository, that section (including the
heading) is used instead as a template for `CONTRIBUTE.md`.

Related to GH-12.
Supersedes GH-22.
@wooorm
Copy link
Collaborator

wooorm commented Nov 15, 2017

I don’t have access to that, so I couldn’t try it out, but GH-57 should do the trick!

@RichardLitt
Copy link
Member Author

What don't you have access to?

@wooorm
Copy link
Collaborator

wooorm commented Nov 16, 2017

Oh sorry this comment went to the wrong issue/pr, it was about the one you mentioned with a Contribute section but no CONTRIBUTE.md file. Never mind!

@RichardLitt
Copy link
Member Author

This is superseded by #57. Closing.

@wooorm
Copy link
Collaborator

wooorm commented Nov 16, 2017

Should the branch be deleted?

@RichardLitt RichardLitt deleted the feat/get-contribute-section branch November 16, 2017 15:46
RichardLitt pushed a commit that referenced this pull request Nov 16, 2017
Previously, if there was no `CONTRIBUTE.md` file, the fixture in this
repo was used.  Now, in this case, and if there’s a `Contribute`
section on the README of the repository, that section (including the
heading) is used instead as a template for `CONTRIBUTE.md`.

Related to GH-12.
Supersedes GH-22.
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.

None yet

2 participants