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

Updated contributing documentation as per parkr. #1192

Merged
merged 5 commits into from Jun 24, 2013

Conversation

Projects
None yet
4 participants
@zachgersh
Copy link
Contributor

commented Jun 7, 2013

Took a stab at updating the contribution guide on documentation. Making things more clear FTW.

@parkr

@mattr-

@parkr

View changes

CONTRIBUTING.md Outdated
pull request when you find it lacking.

You can find the documentation for jekyllrb.com in the
[site/docs](https://github.com/zachgersh/jekyll/tree/master/site/docs) directory,

This comment has been minimized.

Copy link
@parkr

parkr Jun 7, 2013

Member

The whole site/ folder is technically documentation, and if they want to edit styles or something, they may be confused. Better just say site here.

This comment has been minimized.

Copy link
@mattr-

mattr- Jun 8, 2013

Member

Can we point the URL to the authoritative repository? https://github.com/mojombo/jekyll instead of your fork?

@parkr

View changes

CONTRIBUTING.md Outdated

You can find the documentation for jekyllrb.com in the
[site/docs](https://github.com/zachgersh/jekyll/tree/master/site/docs) directory,
it is setup to use jekyll pages.

This comment has been minimized.

Copy link
@parkr

parkr Jun 7, 2013

Member

"... directory. It is a Jekyll site so you'll find your way around in no time."?

heh

@parkr

View changes

CONTRIBUTING.md Outdated
requests directed at another branch will not be accepted.

The [jekyll wiki](https://github.com/mojombo/jekyll/wiki) on github can be freely updated without a pull
request as all github users have access.

This comment has been minimized.

Copy link
@parkr

parkr Jun 7, 2013

Member

GitHub here and in the line above

@parkr

This comment has been minimized.

Copy link
Member

commented Jun 7, 2013

Thanks man! @mattr-?

@zachgersh

This comment has been minimized.

Copy link
Contributor Author

commented Jun 7, 2013

Thanks @parkr will just wait to see if @mattr- has any eagle-eye language changes and then I will make all of these in one commit.

@mattr-

View changes

CONTRIBUTING.md Outdated
Updating Documentation
----------------------

We want the jekyll documentation to be the best it can be and we welcome

This comment has been minimized.

Copy link
@mattr-

mattr- Jun 8, 2013

Member

Capital J here? Unless it's written in lower case everywhere else.

This comment has been minimized.

Copy link
@parkr

parkr Jun 8, 2013

Member

If it's written in lowercase and doesn't refer to the command or the repo, we should capitalize it :)

@mattr-

View changes

CONTRIBUTING.md Outdated
[site/docs](https://github.com/zachgersh/jekyll/tree/master/site/docs) directory,
it is setup to use jekyll pages.

All documentation pull requests should be directed at MASTER. Pull

This comment has been minimized.

Copy link
@mattr-

mattr- Jun 8, 2013

Member

MASTER doesn't need to be capitalized. I would also put it in backticks so that's it's fixed-width formatted.

@@ -82,6 +82,22 @@ git push origin my_awesome_feature
* Create a pull request against mojombo/jekyll and describe what your change
does and the why you think it should be merged.

Updating Documentation

This comment has been minimized.

Copy link
@mattr-

mattr- Jun 8, 2013

Member

The comments above look like they also apply to this file.

@mattr-

This comment has been minimized.

Copy link
Member

commented Jun 8, 2013

Nice work! Just a few little changes to be made and then it should be good to go!

Once we 🙈 🙉 🙊 then it will 🚢

😃

@zachgersh

This comment has been minimized.

Copy link
Contributor Author

commented Jun 11, 2013

Should be all ready to go now!

@parkr

View changes

CONTRIBUTING.md Outdated
----------------------

We want the Jekyll documentation to be the best it can be and we welcome
pull request when you find it lacking.

This comment has been minimized.

Copy link
@parkr

parkr Jun 11, 2013

Member

"pull requests" :)

I think it might sounds better if you said:

"We want the Jekyll documentation to be the best it can be. We've open-sourced our docs and we welcome any pull requests if you find it lacking."

Something like that... @mattr-

This comment has been minimized.

Copy link
@mattr-

mattr- Jun 15, 2013

Member

👍 to that. 🤘

@parkr

View changes

CONTRIBUTING.md Outdated

You can find the documentation for jekyllrb.com in the
[site](https://github.com/mojombo/jekyll/tree/master/site) directory,
it is setup to use Jekyll pages.

This comment has been minimized.

Copy link
@parkr

parkr Jun 11, 2013

Member

"You can find the documentation for jekyllrb.com in the site directory of Jekyll's repo on GitHub.com."

What about that? We need not describe that it is setup to use GitHub Pages or that it's a Jekyll site. It'd be silly if we used something else :)

@parkr

View changes

CONTRIBUTING.md Outdated
All documentation pull requests should be directed at `master`. Pull
requests directed at another branch will not be accepted.

The [Jekyll wiki](https://github.com/mojombo/jekyll/wiki) on GitHub can be freely updated without a pull request as all GitHub users have access.

This comment has been minimized.

Copy link
@parkr

parkr Jun 11, 2013

Member

Line numbers? :)

This comment has been minimized.

Copy link
@zachgersh

zachgersh Jun 18, 2013

Author Contributor

missed the joke :)

This comment has been minimized.

Copy link
@parkr

parkr Jun 18, 2013

Member

I think I was sleepy when I wrote this, hahah. I mean "column numbers," referring to the length of the text on the line. Sorry for the confusion ❤️

This comment has been minimized.

Copy link
@zachgersh

zachgersh Jun 18, 2013

Author Contributor

Yeah, what the crap is going on with that last line! Let me fix that right now.

@zachgersh

This comment has been minimized.

Copy link
Contributor Author

commented Jun 18, 2013

This should now be good to go as well!

@zachgersh

This comment has been minimized.

Copy link
Contributor Author

commented Jun 24, 2013

@parkr @mattr- this should be ready :)

mattr- added a commit that referenced this pull request Jun 24, 2013

Merge pull request #1192 from zachgersh/update_contrib
Updated contributing documentation as per parkr.

@mattr- mattr- merged commit 7f9ccf1 into jekyll:master Jun 24, 2013

1 check passed

default The Travis CI build passed
Details

mattr- added a commit that referenced this pull request Jun 24, 2013

@zachgersh

This comment has been minimized.

Copy link
Contributor Author

commented Jun 24, 2013

👍 @mattr-

@jekyll jekyll locked and limited conversation to collaborators Feb 27, 2017

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
You can’t perform that action at this time.