Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a README #2

Merged
merged 3 commits into from
Oct 7, 2020
Merged

Add a README #2

merged 3 commits into from
Oct 7, 2020

Conversation

github-learning-lab[bot]
Copy link

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.

⌨️ 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.

@mrdrwest
Copy link
Owner

mrdrwest commented Oct 7, 2020

nothing to add

@mrdrwest mrdrwest merged commit e5d810f into master Oct 7, 2020
@github-learning-lab
Copy link
Author

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

@mrdrwest mrdrwest deleted the main-readme branch October 7, 2020 15:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant