savalone47 / oss-enterprise

Open Source Maintainer Expectations

Releasing Open Source

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 to get started. Consider these questions as you start to open source the project.

What should be open source?

It's easier to answer this question in terms of what should not be open sourced:

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.

Open Source Maintainer Expectations

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 to understand what will be expected of you.

FAQ

Who owns the code I contribute to open source projects?

License

This repository is licensed under CC-BY-4.0 (c) 2019 GitHub, Inc.

oss-enterprise's Issues

Open source assessment

Welcome!

Congratulations on taking the first steps to becoming an open source enterprise! This course will be your companion as you explore and develop the resources necessary to ramp up your teams and transform your organization's culture. Through a series of issues and pull requests, you'll create an open source kit: a repository that will house all resources for an open source program.

Throughout the course, you'll be prompted to have offline conversations with departments, teams, and individuals across your organization. To get the most out of this course, consider pausing as the bot prompts you to have these conversations and returning when you're ready. At the end of this course you'll have a fully functional repository with a trove of templates and guides you can use to kickstart your program.

Complete the self assessment

As we begin our journey into preparing for open source, let's start with a few self assessments of where your open source program stands today.

1. Navigate to the open source self assessments.
2. Take each of the assessments.
3. Jot down your level within each dimension.

Choose your code of conduct

Choose a CODE_OF_CONDUCT.md for your organization's open source repository

We'll create a CODE_OF_CONDUCT.md template file.

This template will be recommended for all of your organization's repositories. Unlike the CONTRIBUTING.md, it should not be customized by the maintainers.

A user's experience in your open source project will become a reflection of your brand. How will you protect contributors from harassing or belittling behavior? What will you do when someone is behaving inappropriately? Adding a code of conduct to your projects will promote and facilitate healthy behavior within your community.

Partners in this process

You may want to @ mention the individuals responsible for Diversity, Inclusion and Communication to be your partners in this step.

Why your project needs a code of conduct

For more information on why a code of conduct is a good idea, check out the article opensource.guide: Your Code of Conduct.

Using an established code of conduct

Thought leaders on establishing healthy behaviors in the open source community have joined forces to develop some fantastic drop-in codes of conduct. GitHub makes it easy to drop these established documents in to any project. To read directions on how to use this drop-in code, check out this help documentation.

Here are the drop-in codes of conduct currently supported by GitHub:

• Contributor Covenant
• Citizen Code of Conduct

Adding a code of conduct to an existing project

If you already have an open source project, it is easy to add a code of conduct:

If you consume or contribute to a project that does not have a code of conduct, you should not be shy about suggesting one to the project maintainers.

Should you customize the code of conduct?

It is generally acceptable to customize the code of conduct to meet your organization's needs, however we find the examples developed by the open source community are very good and will meet the needs of the majority of organizations. If you are interested in creating your own, check out some of these examples for inspiration:

• Django Code of Conduct
• Python Community Code of Conduct and Diversity Statement
• Ubuntu Code of Conduct
• Geek Feminism Code of Conduct

Step 4: Code of conduct

Decision Time Decide which code of conduct you will use for your projects. Will you promote the use of an established template or create your own? Based on your decision, follow the path outlined below:

⌨️ Activity: Choose a code of conduct

If you want to use an established code of conduct

1. Create a new code of conduct from a template.
2. Fill in your information on the right side.
3. Click Review and submit.
4. Review the code of conduct and scroll to the bottom of the page.
5. Write a descriptive commit message.
6. Make sure that the option to "create a new branch" is selected, and click Commit new file.
7. Create a new pull request to add a code of conduct.

If you want to use a custom code of conduct

1. Create a new pull request for your custom code of conduct.
2. Enter your code of conduct in the text area.
3. Write a descriptive commit message.
4. Select Create a new branch for this commit and start a pull request.
5. Click Propose new file.
6. Enter the following title for your pull request: Create CODE_OF_CONDUCT.md

---

I'll respond in your new pull request.

Congratulations

🎉 Congratulations

You finished this course! Now, you have an open source tool-kit with the documentation you need to start helping others with open source within your organization.

Saving course resources

1. If you'd like to just save the contents to your machine, you can:
   • Use this shortcut link to download the files
   • Download the files by clicking on the Code tab, clicking on Clone or download and clicking Download ZIP
   • Clone the repository to your machine
2. If you'd like to transfer the repository to an organization on GitHub:
   • If your organization is on GitHub.com, fork it
   • If your organization is on GitHub Enterprise Server, transfer the repository

I won't track any further events in this repository.