Skip to content

create a CONTRIBUTING.md to explain how to contribute to this repo. #201

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.

Sign up for GitHub

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

Merged
colby-swandale merged 4 commits into from
Jan 8, 2018
Merged

create a CONTRIBUTING.md to explain how to contribute to this repo. #201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c6e1b8b
change frontmatter url to the canonical permalink
lostapathy Dec 10, 2017
a47fe48
rename contributing guide to make remove for a conventional CONTRIBUT…
lostapathy Dec 10, 2017
4db5e54
start of new CONTRIBUTING.md
lostapathy Dec 10, 2017
a6794e4
filling out CONTRIBUTING.md
lostapathy Jan 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## How to contribute to guides.rubygems.org
Copy link
Copy Markdown
Contributor

@segiddins segiddins Dec 11, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can put this in .github so we don’t have to rename the existing file?

Copy link
Copy Markdown
Contributor Author

@lostapathy lostapathy Dec 11, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought about that, and I know you suggested it on the other thread, but I feel like putting it at the root is more of the "standard" so it's more likely to be discovered this way, and if it's more likely to be discovered people are more likely to follow it.

Also on https://github.com/rubygems/guides/community - I believe that page would forever link "Contributing" to the old file, which is not desired behavior.


#### If you want to contribute to RubyGems itself, visit [the RubyGems Guides](http://guides.rubygems.org/contributing/)
This guide just covers the details of contributing to the guides themselves.

### Setting up a local development environment

The guides are built with [Jekyll](https://github.com/jekyll/jekyll). To run the site locally, you'll first need to install Jekyll via `gem install jekyll`. Once installed, you can start the development server via `jekyll server` and point your browser to [http://localhost:4000](http://localhost:4000)

### Things you can't update here!

Most of the site can be modified directly in this repository. However, the files below are generated from the [RubyGems source](https://github.com/rubygems/rubygems). Any changes to them need to be updated there and will get applied here when the next RubyGems version is released.

* command-reference.md
* specification-reference.md
2 changes: 1 addition & 1 deletion command-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Command Reference
url: /command-reference
permalink: /command-reference
previous: /patterns
next: /rubygems-org-api
---
Expand Down
2 changes: 1 addition & 1 deletion contributing.md → contributing-to-rubygems.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Contributing to RubyGems
url: /contributing
permalink: /contributing
previous: /resources
next: /faqs
---
Expand Down
2 changes: 1 addition & 1 deletion faqs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Frequently Asked Questions
url: /faqs
permalink: /faqs
previous: /contributing
next: /plugins
---
Expand Down
2 changes: 1 addition & 1 deletion gems-with-extensions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Gems with Extensions
url: /gems-with-extensions
permalink: /gems-with-extensions
previous: /make-your-own-gem
next: /name-your-gem
alias: /c-extensions
Expand Down
2 changes: 1 addition & 1 deletion make-your-own-gem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Make your own gem
url: /make-your-own-gem
permalink: /make-your-own-gem
previous: /what-is-a-gem
next: /gems-with-extensions
---
Expand Down
2 changes: 1 addition & 1 deletion name-your-gem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Name your gem
url: /name-your-gem
permalink: /name-your-gem
previous: /gems-with-extensions
next: /publishing
---
Expand Down
2 changes: 1 addition & 1 deletion patterns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Patterns
url: /patterns
permalink: /patterns
previous: /ssl-certificate-update
next: /specification-reference
---
Expand Down
2 changes: 1 addition & 1 deletion plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Plugins
url: /plugins
permalink: /plugins
previous: /faqs
next: /credits
---
Expand Down
2 changes: 1 addition & 1 deletion publishing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Publishing your gem
url: /publishing
permalink: /publishing
previous: /name-your-gem
next: /security
---
Expand Down
2 changes: 1 addition & 1 deletion resources.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Resources
url: /resources
permalink: /resources
previous: /run-your-own-gem-server
next: /contributing
---
Expand Down
2 changes: 1 addition & 1 deletion rubygems-basics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: RubyGems Basics
url: /rubygems-basics
permalink: /rubygems-basics
previous: /
next: /what-is-a-gem
---
Expand Down
2 changes: 1 addition & 1 deletion rubygems-org-api-v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: RubyGems.org API V2
url: /rubygems-org-api-v2
permalink: /rubygems-org-api-v2
previous: /rubygems-org-api
next: /run-your-own-gem-server
---
Expand Down
2 changes: 1 addition & 1 deletion rubygems-org-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: RubyGems.org API
url: /rubygems-org-api
permalink: /rubygems-org-api
previous: /command-reference
next: /rubygems-org-api-v2
---
Expand Down
2 changes: 1 addition & 1 deletion run-your-own-gem-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Run your own gem server
url: /run-your-own-gem-server
permalink: /run-your-own-gem-server
previous: /rubygems-org-api-v2
next: /resources
---
Expand Down
2 changes: 1 addition & 1 deletion security.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Security
url: /security
permalink: /security
previous: /publishing
next: /ssl-certificate-update
---
Expand Down
2 changes: 1 addition & 1 deletion specification-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Specification Reference
url: /specification-refence
permalink: /specification-refence
previous: /patterns
next: /command-reference
---
Expand Down
2 changes: 1 addition & 1 deletion ssl-certificate-update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: SSL Certificate Update
url: /ssl-certificate-update
permalink: /ssl-certificate-update
previous: /security
next: /patterns
---
Expand Down
2 changes: 1 addition & 1 deletion what-is-a-gem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: What is a gem?
url: /what-is-a-gem
permalink: /what-is-a-gem
previous: /rubygems-basics
next: /make-your-own-gem
---
Expand Down