Link to local helpful markdown files. #132
Conversation
cupakromer
force-pushed
the
add-contributing-to-readme
branch
from
a88ebee to
3f766ef
Compare
|
Did we want to make changes to how any of these markdown files are reference since this is the spec-dev repo? /cc @rspec/rspec |
| spec suite of each of the _other_ project repos. Note that we only run | ||
| the spec suite, not the full build, of the other projects, as the spec | ||
| suite runs very quickly compared to the full build. | ||
|
|
There was a problem hiding this comment.
Looks like this file is a duplicate of the copy in common_markdown_files (and same with the other files below).
Are you keeping it in sync somehow? Or is it necessary for rspec-dev to have them?
There was a problem hiding this comment.
They are not in sync yet. I opened #131 to update our Rake task to get them in sync.
This came up with talking to the group at Ruby for Good. I asked them to go look and see if they could figure out how to get started helping with RSpec. The unanimous response was that it was difficult because there wasn't information in the README.
They've opened PRs on the other repos (I've merged them in) adding a section - it's included in this PR too. Part of that update is including a list to the relative docs (setup, contributing and CoC files) at the project root. That's what I wanted to do here as well.
There was a problem hiding this comment.
Can we not just symlink the files to the ones in the common folder?
There was a problem hiding this comment.
Symlinks won't work on github or windows. So the link in the README won't work properly. Also, several of the markdown files in common_markdown_files/ are really ERB markdown templates. I'm not sure they'll read well for newer people who won't understand that.
cupakromer
force-pushed
the
add-contributing-to-readme
branch
from
16957f7 to
ea660d5
Compare
There was a problem hiding this comment.
hey @cupakromer the info contained in this PR are still valid almost 4 years later?
|
@mberlanda Maybe I can help. What are you trying to do? |
|
Hey @benoittgt, I was trying to figure out if this pr was deprecated by the content of https://github.com/rspec/rspec-dev/tree/master/common_markdown_files 😄 |
|
It's not deprecated, its about making local copies of those files for this repo |
No description provided.