Skip to content
📚 Community guides for open source creators
JavaScript HTML Ruby CSS Shell
Branch: master
Clone or download

Latest commit

Latest commit df7408f Mar 27, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Cache bundler dependencies Feb 10, 2020
_articles Update best-practices.md Mar 26, 2020
_data create pl.yml Feb 22, 2020
_includes Update with original master May 28, 2019
_layouts Update with original master May 28, 2019
assets debug link-error Aug 8, 2019
docs Add note about fork repo collaborators to translation doc Mar 19, 2020
node_modules Resolve node modules changes Jul 5, 2019
script ignore 429 appearing only in CI Mar 21, 2020
test test/prose: allow Romanian quotes. Dec 30, 2019
.gitignore gitignore: remove viscose. Dec 30, 2019
CNAME CNAME updated Apr 16, 2017
CODE_OF_CONDUCT.md Update: HTTP -> HTTPS Dec 25, 2017
CONTRIBUTING.md removed #contribution-review-process tag Jan 11, 2020
Gemfile Tweak Gemfile handling Feb 13, 2018
Gemfile.lock Bump html-proofer from 3.15.1 to 3.15.2 Mar 26, 2020
LICENSE Don’t use curly quotes. Feb 21, 2018
README.md Attempt to replace Travis badge with Actions badge Dec 23, 2019
Rakefile Cleanup Ruby (with RuboCop) Feb 13, 2018
_config.yml zh-cn -> zh-hans, zh-tw -> zh-hant Dec 18, 2019
favicon.ico change favicon to match github Feb 13, 2017
google19d329aaa468a71f.html Added Google Search Verification file Mar 27, 2017
index.html Change translations approach Feb 13, 2018
notices.md Update with original master May 28, 2019
package-lock.json Update with original master May 28, 2019
package.json Update with original master May 28, 2019

README.md

Open Source Guides

Build Status

Open Source Guides (https://opensource.guide/) are a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project.

Background

Open Source Guides were created and are curated by GitHub, along with input from outside community reviewers, but they are not exclusive to GitHub products. One reason we started this project is because we felt that there weren't enough resources for people creating open source projects.

Our goal is to aggregate community best practices, not what GitHub (or any other individual or entity) thinks is best. Therefore, we try to use examples and quotations from others to illustrate our points.

Contributing

This site is powered by Jekyll. Check out our contributing guidelines for ways to offer feedback and contribute.

Licenses

Content is released under CC-BY-4.0. See notices for complete details, including attribution guidelines, contribution terms, and software and third-party licenses and permissions.

Acknowledgments

The initial release of these guides were authored by @nayafia, @bkeepers, @stephbwills, and @mlinksva.

Thanks to @aitchabee, @benbalter, @brettcannon, @caabernathy, @coralineada, @dmleong, @ericholscher, @gr2m, @janl, @jessfraz, @joshsimmons, @kfogel, @kytrinyx, @lee-dohm, @mikeal, @mikemcquaid, @nathansobo, @nruff, @nsqe, @orta, @parkr, @shazow, @steveklabnik, and @wooorm for lending their valuable input and expertise leading up to the initial release, and to @sophshep and @jeejkang for designing and illustrating the guides.

Disclaimer

While we've got advice about running an open source project, we're not lawyers. Be sure to read our disclaimer before diving in.

You can’t perform that action at this time.