Skip to content
This repository was archived by the owner on Sep 1, 2022. It is now read-only.

Commit e924ade

Browse files
authored
Merge pull request #27 from githubtraining/fix-typos
Fix typos & Bug
2 parents 886c3e5 + d406472 commit e924ade

12 files changed

+64
-23
lines changed

responses/00_welcome.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
# Welcome!
1+
# Welcome!
22

3-
This repository will be a working website that you can publish as your own InnerSource commons.
3+
This repository will be a working website that you can publish as your own InnerSource landing page.
44

55
![Screen Shot of final product](https://user-images.githubusercontent.com/6351798/56301905-009cad00-60f6-11e9-9bf4-ed1c1907ef55.png)
66

77
As we work, we'll create a resource that others can use within your organization. This repository will be useful even after you finish this course.
88

99
This is how this course will move along:
10+
1011
- Every new issue or pull request will start with a challenge question
1112
- You'll answer the challenge question _(don't worry, there are no right or wrong answers!)_
1213
- The question will highlight the importance of each topic in InnerSource practices

responses/01_innersource-v-opensource.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22

33
InnerSource and open source are very similar concepts, but they're not the same.
44

5-
**Open source** software public and typically accepts contributions from outside of an organization.
5+
**Open source** software is public and typically accepts contributions from outside of an organization.
66

7-
**InnerSource** is the practice of adopting open source practices internally within your organization. An organization that practices InnerSource, may or may not end up open sourced.
7+
**InnerSource** is the practice of adopting open source patterns internally within your organization. An organization that practices InnerSource may or may not also maintain open source software.
88

9-
You can find your next steps in the [next pull request]({{ url }}).
9+
<hr>
10+
<h3 align="center">You can find your next steps in the <a href="{{ url }}">next pull request</a>.</h3>

responses/01_repo-owner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
This pull request is all about repository ownership and naming conventions.
1+
This pull request is about repository ownership and naming conventions.
22

33
### Challenge question
44

responses/02_repo-owner-answer.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,26 @@ A repository _does_ exist at githubtraining/training-manual, but it is private.
99

1010
## Understanding repository visibility
1111

12-
There are three types of repository visiility: **public, internal, and private**.
12+
There are three types of repository visibility: **public, internal, and private**.
1313

14-
Our repository, `githubtraining/training-manual`, isn't public. It could be internal, which means only members of the organizations that an account owns will see it, or it could be private, which means only teams and individuals that have been granted access to it can see it.
14+
Our repository, `githubtraining/training-manual`, isn't public. It could be _internal_, which means only members of the organizations that an account owns will see it. Or, it could be _private_, which means only teams and individuals that have been granted access to it can see it.
1515

16-
This is an example of why having the right ownership structure is important. Otherwise, it can be difficult for members of your team to find and contribute to projects. Having too many disconnected organizations with restrictive permissions silos and isolates each organization's work.
16+
This is an example of why ownership structure is important. Otherwise, it can be difficult for members of your team to find and contribute to projects. Having too many disconnected organizations with restrictive permissions isolates each organization's work.
17+
18+
Here are some recommendations based on some :sparkles: admirable :sparkles: use of GitHub that we've seen:
1719

18-
Here are some recommendations based on some :sparkles: use of GitHub that we've seen:
1920
- Use the internal visibility (currently in beta) if you're working on behalf of an [enterprise account](https://help.github.com/en/articles/about-enterprise-accounts).
20-
- Name your repositories in a meaningful manner. Usually a simple project or application name will suffice.
21+
- Name your repositories meaningfully. Usually a simple project or application name is best.
22+
2123
<hr>
2224
</details>
2325

24-
Please merge this pull request.
26+
### :keyboard: Activity: Review this pull request
27+
28+
1. Read the additions in the `Files changed` tab
29+
2. Approve this pull request (if needed)
30+
3. Merge this pull request
31+
4. Delete the branch
2532

2633
<hr>
27-
<h3 align="center">I'll respond when you merge this pull request.</h3>
34+
<h3 align="center">I'll respond after you merge this pull request.</h3>

responses/03_discoverable.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
This pull request is all about how to make your repositories more discoverable.
1+
This pull request is about making repositories discoverable.
22

33
### Challenge question
44

@@ -7,4 +7,4 @@ What is this repository for?
77
![gif of a repository with no description, link, or and just a few folders: .github, .vscode, _appendix, _events, _includes, _layouts](https://user-images.githubusercontent.com/6351798/56160925-995feb00-5f85-11e9-8a91-a611936c98bd.gif)
88

99
<hr>
10-
<h3 align="center">I'll respond when I detect you comment on this pull request.</h3>
10+
<h3 align="center">I'll respond when I detect your new comment on this pull request.</h3>

responses/04_discoverability-answer.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,19 @@ This repository is the source code for https://services.github.com.
55
Did you guess it? Probably not, because it doesn't contain many of the necessary elements to make a repository discoverable.
66

77
Some suggestions to ensure your teammates can find your repository are:
8+
89
- Use a descriptive repository name
910
- Give your repository a description
1011
- Provide a URL for the deployment of the app, or documentation about this project
1112

12-
Discover more about how to make a repository discoverable by visiting the **Files Changed** tab. It's OK if you want to do this later, any resources we cover throughout the course will be available at the end.
13+
Discover more about how to make a repository discoverable by visiting the **Files Changed** tab. It's OK if you want to do this later, any resources we cover throughout the course will be available at the end.
14+
15+
### :keyboard: Activity: Discoverability
1316

14-
Please merge this pull request.
17+
1. Review the additions about discoverability in the `Files changed` tab
18+
2. Approve this pull request (if needed)
19+
3. Merge this pull request
20+
4. Delete the branch
1521

1622
<hr>
1723
<h3 align="center">I'll respond when you merge this pull request.</h3>

responses/06_templates-answer.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
### Answer :crystal_ball:
22

3-
Every project _can_ have a different way to submit bug reports, so all the answers are right.
3+
Every project _can_ have a different way to submit bug reports, so all the answers are right.
44

55
But, how could you know? With issue and pull request templates, you can take the mystery out of the equation. Templates show those across the organization the preferred way to contribute.
66

7-
Please merge this pull request.
7+
### :keyboard: Activity: Review templates
8+
9+
1. Review the examples and types of template files in the `Files changed` tab
10+
2. Approve this pull request (if needed)
11+
3. Merge this pull request
12+
4. Delete the branch
813

914
<hr>
1015
<h3 align="center">I'll respond when you merge this pull request.</h3>

responses/07_workflows.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
This pull request covers a few common workflows that are likely in use within your organization.
1+
This pull request covers a few common workflows that may be used within your organization.
22

33
### Challenge question
44

5-
Suppose you'd like to contribute to the repository pictured below. Which branch should I use as a base for my contributions?
5+
Suppose you'd like to contribute to the repository pictured below. Which branch should you use as a base for your contributions?
66

77
![a screenshot of a repository's branches, they are: a protected master branch, a protected release-v1.0 branch. The rest are unprotected: bug-fix, green-colors, config-release-drafter, add-template](https://user-images.githubusercontent.com/16547949/56039935-5d1d5800-5d03-11e9-8a26-29d36cfc7499.png)
88

responses/08_workflows-answer.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@ This pull request covers the basics, but here are some recommendations to help a
88
- If you haven't picked a workflow, use a common and well documented one.
99
- Be explicit about your deployment and release strategy.
1010

11-
Please merge this pull request.
11+
### :keyboard: Activity: Review workflow documentation
12+
13+
1. Review the changes in the `Files changed` tab
14+
2. Approve this pull request (if needed)
15+
3. Merge this pull request
16+
4. Delete the branch
1217

1318
<hr>
1419
<h3 align="center">I'll respond when you merge this pull request.</h3>

responses/10_projects-answer.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,12 @@ Without a clear project management strategy, you might as well pick any issue.
44

55
Being explicit about your project management tool will help potential contributors. Whether it's inside of GitHub or elsewhere, communicate so they know whether their help is immediately helpful.
66

7+
### :keyboard: Activity: Review project management strategies
8+
9+
1. Review the changes in the `Files changed` tab
10+
2. Approve this pull request (if needed)
11+
3. Merge this pull request
12+
4. Delete the branch
13+
714
<hr>
815
<h3 align="center">I'll respond when you merge this pull request.</h3>

0 commit comments

Comments
 (0)