docs(core): add markdown document outlining contribution guidelines#2432
docs(core): add markdown document outlining contribution guidelines#2432caleywoods wants to merge 4 commits into
Conversation
|
Any opinions on having the PR specific stuff in an actual PR template : https://docs.github.com/en/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository? I.e. if its there, when you open a PR it auto populates the box with the contents of that file. |
That could work too! I was just thinking that this document would be that after it gets configured as such inside GitHub but there is a lot that would be listed. I think your idea might be the better approach to just have the PR template outline the desired format and have something maybe at the bottom of it linking to the bigger document on the website. |
|
@CrossR I've updated the verbiage to put the important stuff at the top. The document still seems like it would be fairly daunting so I don't think it should grow anymore. Do you see any opportunities to shrink it? |
|
Caley Woods seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
This is the start of a markdown document that outlines the guidelines for contributing. I recently submitted my first pull request and I hadn't read the contributing document on the Onivim website, it's a little bit buried in there. I wanted to open this up for discussion before I spent the time copying all of the guidelines into the document.
I think having this would go a long way towards helping new contributors like myself adhere to the requested guidelines. If rehashing the contribution guidelines here isn't wanted since it duplicates things, then I think it should at least be considered that a
contributing.mddocument be pulled in or created that kindly asks contributors to take a moment to read the guidelines already present on the website.