search

jswboseok / oss-enterprise

https://lab.github.com/githubtraining/create-an-open-source-program
Creative Commons Attribution 4.0 International
0 stars 0 forks source link

Add a README #2

Closed github-learning-lab[bot] closed 4 years ago

github-learning-lab[bot] commented 4 years ago

Step 2: Update the README for your open source kit

This pull request adds a file called README.md to this open source kit. This repository is where people will come for help and information when they want to open source projects within your organization. The information in the README.md should help give those people what they're looking for.

This README.md is not a template for others when open sourcing their projects. Instead, this provides guidelines for when to open source projects and how to do it.

The README.md already has some great information. Customize the document with more recommendations for your company and then merge.

It's a good idea to include links to other documents that you've created (or will create in the future). For example, add other links to things like your CODE_OF_CONDUCT.md and CONTRIBUTING.md. Then, others will know that the templates exist and should be used.

:keyboard: Activity: Reflect on a README.md

  1. Answer all of these questions:
    • What is the purpose of this repository?
    • Who should someone contact if they have questions?
    • How should someone make contact if they have questions?
    • What are the first steps to getting started open sourcing a project?
    • How does this repository relate to other projects and business goals?
  2. Update the README.md in this pull request to reflect the information you want to include about your project.
  3. When you're ready to move on, merge this pull request.

I'll respond when you merge this pull request.

github-learning-lab[bot] commented 4 years ago

Great! Let's go to the next pull request.