/open-source-guide

Community guides for open source creators
  1. HTML 36.8%
  2. CSS 27.1%
  3. JavaScript 26.1%
  4. Ruby 8.2%
  5. Shell 1.8%
HTML CSS JavaScript Ruby Shell
Find file
Latest commit 387dd5e Feb 18, 2017 @bkeepers bkeepers committed on GitHub Merge pull request #300 from github/coralineada/reposibilities 
Added a section on responsibilities to CoC page
Permalink
Failed to load latest commit information.
_articles Tweak based on mlinksva's feedback Feb 18, 2017
_data Stupid tests Feb 13, 2017
_includes Merge pull request #270 from sotayamashita/fix/border-remains-when-ve… Feb 15, 2017
_layouts Remove the trailing slash in breadcrumbs Feb 17, 2017
assets Merge pull request #275 from rixx/patch-1 Feb 16, 2017
docs Fix typo nagivation -> navigation Feb 14, 2017
js Fix Feb 16, 2017
node_modules save production dependencies Feb 11, 2017
script Bundle update if check fails Feb 16, 2017
test Remove outdated test Feb 13, 2017
.bowerrc add anchor.js Oct 3, 2016
.gitignore ask pages version, don't checkin Gemfile.lock Feb 11, 2017
.travis.yml Fix travis on gh-pages branch Feb 17, 2017
CNAME Point CNAME to opensource.guide Sep 7, 2016
CODE_OF_CONDUCT.md update coc Jan 31, 2017
CONTRIBUTING.md Broken link in environment setup section Feb 16, 2017
Gemfile ask pages version, don't checkin Gemfile.lock Feb 11, 2017
LICENSE cc-by-4.0 content, mit code Aug 17, 2016
README.md 📛 Add Travis CI badge Feb 18, 2017
Rakefile Add lint tests Aug 9, 2016
_config.yml Default twitter card Feb 13, 2017
bower.json Rename repo to open-source-guide Nov 7, 2016
favicon.ico change favicon to match github Feb 13, 2017
index.html Fix nested <p> tags Feb 16, 2017
notices.md Clarify the interaction of the CC-BY license and trademark rights Feb 14, 2017
package.json Reorganize CSS to have new stuff Feb 1, 2017
search.html Perform search on keypress Oct 7, 2016

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

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, which gives you permission to use content for almost any purpose (but does not grant you any trademark permissions), so long as you note the license and give credit, such as follows:

Content based on github.com/github/open-source-guide used under the CC-BY-4.0 license.

Code, including source files and code samples if any in the content, is released under CC0-1.0.

This means you can use the code and content in this repository except for GitHub trademarks in your own projects.

When you contribute to this repository you are doing so under the above licenses.

Screenshots in the guide are used according to various 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.