githubtraining / oss-enterprise

Course repo for Learning Lab course "Create an open source program"

Course: Create an open source program

This repository powers the Learning Lab course Create an open source program.

Every Learning Lab course is made up of:

• a course repository, and
• a template repository

The course repository is written in YAML and Markdown. The template repository could be written in any language that supports the learning objectives.

For more information on the goals of this course, check out the course-details.md.

Contribute

See something we could improve? Check out the contributing guide in the community contributors repository for more information on the types of contributions we ❤️ and instructions.

We ❤️ our community and take great care to ensure it is fun, safe and rewarding. Please review our Code of Conduct for community expectations and guidelines for reporting concerns.

License

All Learning Lab course repositories are licensed under CC-BY-4.0 (c) 2019 GitHub, Inc. The template repositories associated with each course may have different licenses.

When using the GitHub logos, be sure to follow the GitHub logo guidelines

oss-enterprise's Issues

Update template to have lowercase use of word "Open Source"

The template repo uses "Open Source" instead of "open source" throughout the README. We'll need to update the template so that it reads as lowercase.

Add information about each level of maturity in survey

In the OSS maturity assessment (take it, see the source), we give people a score against these dimensions when they're done taking the survey:

• Consuming open source projects
• Contributing to open source projects
• Producing open source software
• Embedded culture

We also provide indicators of each dimension (an indicator is really just the questions in the survey that contributed to a weight toward that dimension). However, we don't explain the dimension in detail.

We should create an explanation about that dimension (~ 1 paragraph at least I think) that gives people more context about it. If a resource already exists, we can link to it.

Merge conflicts happening

Since there was a change to the README in the template repo, there are now merge conflicts.

We will need to re-write history so all of the branches come from the most recent commit on the template repo:

• https://github.com/githubtraining/open-source-kit

Branches needing rewritten:

• main-readme
  • delete the branch locally
  • create a new branch with the same name from master
  • cherry-pick 5856230728c6ed573db761f14c546df974875b5a
  • force push
• code-of-conduct - should be deleted on the remote

Add an activity for enforcement of COC

The course is pretty repetitive, but we have an opportunity to add an activity about enforcement of the code of conduct. Or maybe that's better left as a separate course. Opening this issue as a placeholder for the idea.

Improve course README

The course description, tagline, and readme need to be softened a bit so we don't make the process so intimidating.

From @crichID:

The course description mentions that setting up an open source program is overwhelming. Should we tone that down a little? Also in the course description, we should try to reinforce the open source enterprise messaging.

From @mattdavis0351:

If I could add to what @crichID said. I think calling it overwhelming is too intimidating. As I took this course I thought to myself "I don't have a whole lot of time before I got get my kids... do I even want to start this right now?" because of that verbiage, even though it was stated that you "don't have to do this all at once."

Transfer maturity assessment to survey monkey

If not Survey Monkey, some other shared place. Maybe it shouldn't really be a part of the course but the learning path.

See: https://github.com/github/services/issues/5668

Validate each merged PR title

Most steps close a PR. We're validating that we're merging PRs, but we're not validating each title. We should validate that each merged PR is the title we expect. If not, we can respond with a new error response.

This will help if folks get stuck the bot won't just stop responding randomly.

Create README

We need to create the README which is necessary for the course catalog.

Add an activity for picking an open source license

We have an opportunity to provide some use cases for different licenses and helping the learner pick which one fits each use case. Could also be a standalone course.

Link, incorrect language

Bug Report

Current behavior

Link: The state of enterprise open source: A Red Hat report is in Italian

Reproduction
Steps to reproduce the behavior in the course:

1. Go to https://lab.github.com/githubtraining/paths/become-an-open-source-enterprise
2. Click on/ or hover over The state of enterprise open source: A Red Hat report
3. The document is in Italian instead of English

Expected behavior
The document should be in English

Possible solution
use https://www.redhat.com/en/enterprise-open-source-report/2019 instead

In addition
I'm having a hard time finding the Learning Paths markdown and repo, I'll keep trying!

Clear step numbers and descriptions

Reported by @crichID in https://github.com/github/services/issues/5546#issuecomment-494178389:

The actions required in the "Establish Program Goals" step aren't clear. We should use the same format as we do for other courses with ### Step 1: xxx to call out what we are asking the learner to do.

The steps in the course detail page use inconsistent punctuation.

Replace assessment with PDF conversation guide

Feature Request

Describe the problem/friction you are trying to solve
The current assessment isn't open source, and it is out of date with the most recent internal efforts of @githubtraining/trainers.

Describe your ideal solution
Based on a suggestion from @crichID, we could replace the assessment with a PDF of a conversation guide.

Close maturity assessment issue

The maturity assessment, the first welcome issue, is created as a part of the setup. Right now, we're never closing it. Do we want to? cc @hectorsector

Soften README description

This pull request closes #15 by changing some of the language in the README.md. I did not change the tagline or description in the config, because I don't think they need changed.

cc @hectorsector 👀

Match survey messaging to first issue

Also on the assessment, I noticed the language we use in the results page of the assessment (embedded culture) don't match the levels in the matrix we show in the first issue.

Reported by @crichID in https://github.com/github/services/issues/5546#issuecomment-494178389

Build up to the open source kit

Review the responses so we build up to the open source kit.

From @crichID in https://github.com/github/services/issues/5546#issuecomment-494178389:

In the first PR, we call it an open source kit but we don't do much to build up why they are creating an open source kit. There is one small sentence in the first paragraph but it needs more. I think it would be helpful to fill in some of the missing pieces like this.

Template repo README

The README on the template repo is still for a facilitated course. It needs to be changed for this course.

Reported by @crichID on https://github.com/github/services/issues/5546#issuecomment-494178389

Check for "maturity" mentions in the assessment

Review all responses + the survey and remove all mentions of the word "maturity" since it may have negative connotations to some.

Reported by @crichID in https://github.com/github/services/issues/5546#issuecomment-494178389

Code of conduct PR

When I did the code of conduct, there was a new PR opened against master. That was a bit confusing, but it could have been addressed in the instructions and I missed it.

The instructions should be reviewed so we either ask them to:

• not follow GitHub's flow for adding the code of conduct
• Ask them to follow the flow, but then have them open a pull request against the existing branch
• Ask them to follow the flow, and then have the bot respond in that pull request ( ⭐️) my favorite

Review open source enterprise messaging

Review the course to ensure we're aligned with the company's open source messaging.

Reported by @crichID in https://github.com/github/services/issues/5546#issuecomment-494178389

Improve final issue

The final issue is pretty bare and needs some content, like additional courses, learning paths, resources.