Skip to content

Commit

Permalink
Merge pull request #2 from mrdrwest/main-readme
Browse files Browse the repository at this point in the history
Add a README
  • Loading branch information
mrdrwest committed Oct 7, 2020
2 parents a786a81 + 7d19424 commit e5d810f
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
# Getting Started with Open Source in the Enterprise
# Releasing Open Source

Welcome to our course on **Getting Started with Open Source in the Enterprise**. We are excited to join you in this journey and look forward to helping you meet your OSS goals.
You want to release something as open source? Awesome! It's up to you to get it ready, but don't worry, you are never alone. Open a [new issue](issues/new?template=new-release.md) to get started. [Consider these questions as you start to open source the project.](docs/key-questions-for-choosing-projects.md)

### How It Works
## What should be open source?

This is not your average training course. This is a self-guided journey, where we will be supporting you and your team in creating the necessary documents to define and communicate your Open Source program.
It's easier to answer this question in terms of what should **not** be open sourced:

We like to call this repository an **Open Source Tool Kit**. It doesn't look like much right now, but when we are done with this repository, you will move it to your own GitHub organization where it will become a resource for the developers inside your organization who are using, contributing or releasing Open Source projects.
1. Don't open source anything that represents core business value. If it makes us lots of money by being closed source, don't open source it.
2. Don't open source anything that is specific to internal processes. If it won't be useful to anyone that doesn't work here, don't open source it.
3. Don't open source anything you can't commit to maintaining long-term. Some projects are inherently difficult to maintain. If you don't want to spend time accepting contributions and working with the open source community, don't open source it.

This is a **learning** repository. You will see that the `github-learning-lab` bot will open some Issues and Pull Requests for you. The best part is, even though these Issues and Pull Requests will be merged/closed as we move through the course, they will still be there -- and serve as a treasure trove of information -- for those who join the repository later.
## Open Source Maintainer Expectations

### Getting Started
Before you open source your project, consider the effort required to maintain it. Being an great open source maintainer requires more effort than managing a closed source project. Read our [Maintainer Guide](docs/maintainers-guide.md) to understand what will be expected of you.

We hope you are excited to get started! Head over to the take your first steps toward a :sparkles: Open Source program for your company.
## FAQ

#### Who owns the code I contribute to open source projects?

## License

Expand Down

0 comments on commit e5d810f

Please sign in to comment.