Skip to content

Commit

Permalink
Merge branch 'gh-pages' into self-referential
Browse files Browse the repository at this point in the history
* gh-pages: (73 commits)
  Revert SEO titles (github#126)
  Update lint rules
  added phantom example
  fix broken homebrew link
  add link to further reading
  Update prose dependencies, refactor
  Add description
  add jekyll-sitemap
  Use a collection instead of pages for the articles
  Fix the link to the homepage
  Override HTML title on certain pages
  Add an image to the article
  Add an optional alternate html page title
  Update the project titles
  Duplicate the titles to the navigation
  Add support for alternate nav text
  Ignore link to private repo for now
  Add metadata
  Rename index to html
  Add title back in
  ...
  • Loading branch information
bkeepers committed Sep 29, 2016
2 parents c5a5f6f + 403f442 commit ef0cb96
Show file tree
Hide file tree
Showing 54 changed files with 770 additions and 524 deletions.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ If you've been active on this project (such as writing helpful content, answerin

## Community

Handbook discussions take place on this repository's [Issues](https://github.com/github/open-source-handbook/issues) and [Pull Requests](https://github.com/github/open-source-handbook/pulls) sections. Anybody is welcome to join these conversations. There is also a mailing list for regular updates.
Handbook discussions take place on this repository's [Issues](https://github.com/github/open-source-handbook/issues) and [Pull Requests](https://github.com/github/open-source-handbook/pulls) sections. Anybody is welcome to join these conversations. There is also a [mailing list](
http://eepurl.com/cecpnT) for regular updates.

Wherever possible, do not take these conversations to private channels, including contacting the maintainers directly. Keeping communication public means everybody can benefit and learn from the conversation.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ This handbook was originally created and curated by GitHub, along with input fro

A big reason we started this project is because we felt that there weren't enough resources for people creating open source projects. We made the Handbook itself 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](docs/roadmap.md).

## 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](/CONTRIBUTING.md) for ways to offer feedback and contribute.
Expand Down
30 changes: 15 additions & 15 deletions getting-started/index.md → _articles/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,15 @@
---
title: Getting started
next: getting-started/defining.md
following: _articles/getting-started/defining.md
contents:
- getting-started/defining.md
- getting-started/setting-expectations.md
- getting-started/branding.md
- getting-started/preparing.md
- getting-started/legal.md
- _articles/getting-started/defining.md
- _articles/getting-started/setting-expectations.md
- _articles/getting-started/branding.md
- _articles/getting-started/preparing.md
- _articles/getting-started/legal.md
---

We'll start with the basics: What is open source? What do you need to know before launching a project?

The Open Source Handbook is meant to help you launch projects of all shapes and sizes. While we cover strategies that are relevant to every project, you may find certain sections more or less useful, depending on what you need.

One more thing: we can give you advice on running an open source project, but we're not lawyers. Be sure to read our [disclaimer](../disclaimer) before you dive in.
First things first: we're here to help you launch projects of all shapes and sizes, but you may find certain sections more or less useful, depending on what you need.

* TOC
{:toc}
Expand All @@ -22,24 +18,28 @@ One more thing: we can give you advice on running an open source project, but we

You've heard a lot about this "open source" thing and you'd like to release a project for the first time.

If you're worried about getting things right, check out ["Preparing for launch"](preparing) for a quickstart guide, as well as the [Marketing](../marketing) section.
If you're worried about getting things right, check out ["Preparing for launch"](preparing/) for a quickstart guide, as well as the [Marketing](../marketing/) section.

## You've open sourced projects before, but you'd like to sharpen your skills

You currently maintain a few open source projects. You understand the basic mechanics, but there are some things you think you could do better.

If you're hoping to improve your skills as a maintainer, take a look at the [Sustaining Growth](../sustaining) and [Troubleshooting](../troubleshooting) sections.
If you're hoping to improve your skills as a maintainer, take a look at the [Sustaining Growth](../sustaining/) and [Troubleshooting](../troubleshooting/) sections.

## You're trying to build a large community project

For you, the best part about open source is _collaboration_. You're excited to work on a project with people from all over the world.

If community is important to you, keep an eye out for resources such as ["Building a community"](../marketing/building-community) and ["Sustaining healthy communities"](../sustaining/healthy-communities).
If community is important to you, keep an eye out for resources such as ["Building a community"](../marketing/building-community/) and ["Sustaining healthy communities"](../sustaining/healthy-communities/).

## You're a company open sourcing a project

Your company is about to open source a previously internal project. You want to do it without breaking any laws or upsetting anyone who will interact with your project.

If you're worried about making lawyers happy, ["The legal side of open source"](legal) and ["Leadership & governance"](../sustaining/leadership) can help you with trademark, license, and other company matters.
If you're hoping to become a good corporate citizen, ["The legal side of open source"](legal/) and ["Leadership & governance"](../sustaining/leadership/) can help you with trademark, license, and other company matters.

---

One more thing: we can give you advice on running an open source project, but we're not lawyers. Be sure to read our [disclaimer](../disclaimer/) before you dive in.

Ready to go? Let's get started!
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Branding
next: getting-started/preparing.md
following: _articles/getting-started/preparing.md
---

Wondering what to name your project? Let's talk about your project's brand.
Expand All @@ -24,9 +24,9 @@ Consider clarity above all. Puns are fun, but remember that some jokes might not

Make sure that your project's name doesn't infringe upon any trademarks. A company might ask you to take down your project later on, or even take legal action against you. It's just not worth the risk. You can check the [WIPO Global Brand Database](http://www.wipo.int/branddb/en/) for trademark conflicts. If you're at a company, this is one of the things your [legal team can help you with](../legal/#what-does-my-companys-legal-team-need-to-know).

You'll also want to double-check for open source projects with a similar name, especially if you share the same language or ecosystem. If your name overlaps with a popular existing project, you'll probably confuse your audience. You can check for similar project names [here](http://ivantomic.com/projects/ospnc/).
You'll [also want to check](http://ivantomic.com/projects/ospnc/) for open source projects with a similar name, especially if you share the same language or ecosystem. If your name overlaps with a popular existing project, you might confuse your audience.

Consider whether you'll want a website, Twitter handle, or other properties to represent your project. If so, make sure you can get the names you want. Ideally, reserve those names now for peace of mind. You can check for domain name availability [here](https://instantdomainsearch.com/).
Consider whether you'll want a website, Twitter handle, or other properties to represent your project. If so, make sure you can get the names you want. Ideally, [reserve those names now](https://instantdomainsearch.com/) for peace of mind.

Finally, it doesn't hurt to do a quick Google search for your project name. Will people be able to easily find your project? Does something else appear in the search results that you wouldn't want them to see?

Expand All @@ -40,15 +40,16 @@ Throughout the life of your project, you'll do a lot of writing: READMEs, tutori
>
> Every time I join and read, I see the culture that I helped plant there seven years ago and it makes me very proud.
Using warm, inclusive language (such as using "them", even when referring to the single person) can go a long way in making your project feel welcoming to new contributors. Also consider using simple language when writing, as many of your readers may not be native English speakers.
Using warm, inclusive language (such as "them", even when referring to the single person) can go a long way in making your project feel welcoming to new contributors. Also consider using simple language when writing, as many of your readers may not be native English speakers.

Beyond how you write words, your coding style may also become part of your project's brand. For example, [Angular](https://github.com/johnpapa/angular-styleguide) and [jQuery](http://contribute.jquery.org/style-guide/js/) are two projects with rigorous coding styles and guidelines.

It isn't necessary to write a style guide for your project when you're just starting out, and you may find that you enjoy incorporating different coding styles into your project anyway. But you should anticipate how your writing (and coding) style might attract (or not attract) different types of people. The earliest stages of your project are your opportunity to set the precedent you wish to see.

We're almost there! Next, we'll walk you through a few components that every open source project should include when you launch.
We're almost there! Next, we'll walk you through a few components that every open source project should include before launch.

## Further reading

* [Choose a Good Name](http://producingoss.com/en/getting-started.html#choosing-a-name) from _Producing Open Source Software_ by @kfogel
* [Hemingway](http://www.hemingwayapp.com/): tool to help you write in simple, clear prose
* [WIPO Global Brand Database](http://www.wipo.int/branddb/en/) to check for trademark conflicts
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
---
title: What it means to open source
next: getting-started/setting-expectations.md
following: _articles/getting-started/setting-expectations.md
---

## What does it mean to open source a project?

So you're interested in making your project open source? Congratulations! 🎉 The world appreciates your contribution.

Before we get into the details of running an open source project, let's talk about what open sourcing a project actually means.
Let's start by talking about what it means to open source your work.

## Open source is more than just a license

Expand All @@ -17,7 +15,7 @@ Open source licenses grant permission to everyone to use, modify, and share lice

That's the legal side of it. In terms of culture, open sourcing a project has come to mean much more. There are many reasons why a person or organization might want to open source a project. For example:

* **Transparency:** Anyone can inspect an open source project for errors or inconsistencies. Transparency matters to governments like [Bulgaria](https://medium.com/@bozhobg/bulgaria-got-a-law-requiring-open-source-98bf626cf70a) or the [United States](https://sourcecode.cio.gov/), regulated industries like banking or healthcare, and security-related software like [Let's Encrypt](https://github.com/letsencrypt).
* **Transparency:** Anyone can inspect an open source project for errors or inconsistencies. Transparency matters to governments like [Bulgaria](https://medium.com/@bozhobg/bulgaria-got-a-law-requiring-open-source-98bf626cf70a) or the [United States](https://sourcecode.cio.gov/), regulated industries like banking or healthcare, and security software like [Let's Encrypt](https://github.com/letsencrypt).

* **Collaboration:** Open source projects can accept changes and updates from anybody, which means they benefit from multiple skill sets and experiences. Collaboration matters to those who want to build their projects with a community, like [Hoodie](https://github.com/hoodiehq) and [Rust](https://github.com/rust-lang/rust).

Expand All @@ -27,11 +25,15 @@ Remember: open source isn't just for software! You can open source everything fr

## Public projects on GitHub without a license are not open source

When you publish a project on GitHub, [you have the option](https://help.github.com/articles/creating-a-new-repository/) to make the repository **private** or **public**.
When you [create a new project](https://help.github.com/articles/creating-a-new-repository/) on GitHub, you have the option to make the repository **private** or **public**.

Public repositories on GitHub are covered by [GitHub's Terms of Service](https://help.github.com/articles/github-terms-of-service/#f-copyright-and-content-ownership), which gives other people the right to view and fork your repository. But if you want others to use, copy, modify, or contribute back to your project, you need to include an open source license.

Public repositories on GitHub are covered by [GitHub's Terms of Service](https://help.github.com/articles/github-terms-of-service/#f-copyright-and-content-ownership), which gives other people the right to view and fork your repository. But if you want others to use, copy, modify, or contribute back to your project, you need to [include an open source license](https://help.github.com/articles/open-source-licensing/).
A **public** repository is not **open source** unless you choose an open source license. For example, someone cannot legally use any part of your GitHub project in their code, even if it's public, unless you explicitly give them the right to do so. (You can learn more about the legal side of open source [here](../legal/).)

A public repository is not automatically open source unless you pick a license that grants a certain set of rights to people who might interact with your project. For example, someone cannot legally use any part of your GitHub project in their code, even if it's public, unless you explicitly give them the right to do so. (You can learn more about the legal side of open source [here](../legal).)
It's easy to add a license. You'll be [asked to add one](https://help.github.com/articles/open-source-licensing/) when you create a new repository.

---

When you open source a project, you open yourself to feedback and suggestions from other people who are engaged with your work. It might feel intimidating to open source a project for the first time, but remember that you're not alone.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: The legal side of open source

Sharing your creative work with the world can be an exciting and rewarding experience. It can also mean a bunch of legal things you didn't know you had to worry about.

Thankfully, you don't have to start from scratch. This section will make sure you've got all your legal needs covered. Before you dive in, be sure to read our [disclaimer](../../disclaimer).
Thankfully, you don't have to start from scratch. This section will make sure you've got all your legal needs covered. Before you dive in, be sure to read our [disclaimer](../../disclaimer/).

* TOC
{:toc}
Expand Down
Loading

0 comments on commit ef0cb96

Please sign in to comment.