/opensource.guide

Community guides for open source creators
  1. JavaScript 40.6%
  2. HTML 30.8%
  3. CSS 18.1%
  4. Ruby 5.6%
  5. Shell 4.9%
JavaScript HTML CSS Ruby Shell
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP
Find file
Switch branches/tags
Nothing to show
Image Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github add pr template Jul 11, 2017
_articles/en-US fix test: curly to single quote Dec 2, 2017
_data i18n Open Source Friday index lead Oct 6, 2017
_includes Hide link to translations until there is > 1 Aug 10, 2017
_layouts Merge remote-tracking branch 'origin/gh-pages' into i18n Aug 10, 2017
assets Merge remote-tracking branch 'origin/gh-pages' into i18n Aug 10, 2017
docs Fix broken link to automated tests Dec 1, 2017
node_modules Reinstall primer deps Jul 24, 2017
script Fix branch name in sync script Aug 10, 2017
test Merge remote-tracking branch 'origin/gh-pages' into i18n Aug 10, 2017
.bowerrc add anchor.js Oct 3, 2016
.gitignore Ignore package-lock.json Aug 10, 2017
.travis.yml libcurl4-openssl-dev to avoid SSL errors in tests Oct 4, 2017
CNAME Point CNAME to opensource.guide Sep 7, 2016
CODE_OF_CONDUCT.md update coc Jan 31, 2017
CONTRIBUTING.md Adding a missing word Oct 21, 2017
Gemfile Remove jekyll-octicons plugin Mar 4, 2017
LICENSE cc-by-4.0 content, mit code Aug 17, 2016
README.md update readme Oct 17, 2017
Rakefile Add lint tests Aug 9, 2016
_config.yml Merge remote-tracking branch 'origin/gh-pages' into i18n Aug 10, 2017
favicon.ico change favicon to match github Feb 13, 2017
google19d329aaa468a71f.html Added Google Search Verification file Mar 27, 2017
index.html i18n Open Source Friday index lead Oct 6, 2017
notices.md Update repo name Mar 6, 2017
package.json Move test dependencies, stop ignoring `node_modules` Jul 24, 2017

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

The first set of Open Source Guides were created and curated by GitHub, along with input from outside community reviewers, but they are not exclusive to GitHub products.

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.

Open Source Guides are a resource and a discussion forum. One reason we started this project is because we felt that there weren't enough resources for people creating open source projects. We made these guides open source in hopes that you'll use this space to talk about best practices, then document them when you've found consensus. We'd like this to be a safe space to talk about what's hard, what's scary, and what's simply confusing about running open source projects.

Roadmap

We've shared our vision and priorities for this project in our roadmap.

Contributing

This site is powered by Jekyll. Our goal is for this project to reflect community best practices, so we'd love your input! Got a question or an idea? 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.