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

docs(core): add markdown document outlining contribution guidelines #2432

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

caleywoods
Copy link
Contributor

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.md document be pulled in or created that kindly asks contributors to take a moment to read the guidelines already present on the website.

@CrossR
Copy link
Member

CrossR commented Sep 10, 2020

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.

@caleywoods
Copy link
Contributor Author

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.

@caleywoods
Copy link
Contributor Author

@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?

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


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.

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.

3 participants