Skip to content

Commit 4b94ec8

Browse files
committed
Fixing editorial inconsistencies
1 parent c8f7569 commit 4b94ec8

10 files changed

+17
-17
lines changed

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Our Pledge
44

55
In the interest of fostering an open and welcoming environment, we as
6-
contributors and maintainers pledge to making participation in our project and
6+
contributors and maintainers pledge to make participation in our project and
77
our community a harassment-free experience for everyone, regardless of age, body
88
size, disability, ethnicity, gender identity and expression, level of experience,
99
nationality, personal appearance, race, religion, or sexual identity and

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ There are many ways you can directly contribute to the guides (in descending ord
2424
* Fix editorial inconsistencies or inaccuracies
2525
* [Translate guides into other languages](docs/translations.md)
2626

27-
Interested in making a contribution? Read on!
27+
Interested in contributing to this Open Source Guide? Read on!
2828

2929
## Ground rules & expectations
3030

_articles/best-practices.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ For example, @lord discovered that having a project vision helped him figure out
4747

4848
<aside markdown="1" class="pquote">
4949
<img src="https://avatars.githubusercontent.com/lord?s=180" class="pquote-avatar" alt="avatar">
50-
I fumbled it. I didn't put in the effort to come up with a complete solution. Instead of an half-assed solution, I wish I had said "I don't have time for this right now, but I'll add it to the long term nice-to-have list."
50+
I fumbled it. I didn't put in the effort to come up with a complete solution. Instead of a half-assed solution, I wish I had said "I don't have time for this right now, but I'll add it to the long term nice-to-have list."
5151
<p markdown="1" class="pquote-credit">
5252
@lord, ["Tips for new open source maintainers"](https://lord.io/blog/2014/oss-tips/)
5353
</p>
@@ -104,7 +104,7 @@ If you receive a contribution you don't want to accept, your first reaction migh
104104

105105
<aside markdown="1" class="pquote">
106106
<img src="https://avatars.githubusercontent.com/krausefx?s=180" class="pquote-avatar" alt="avatar">
107-
The key to handle support for large-scale open source projects is to keep issues moving. Try to avoid having issues stall. If you're an iOS developer you know how frustrating it can be to submit radars. You might hear back 2 years later, and are told to try again with the latest version of iOS.
107+
The key to handling support for large-scale open source projects is to keep issues moving. Try to avoid having issues stall. If you're an iOS developer you know how frustrating it can be to submit radars. You might hear back 2 years later, and are told to try again with the latest version of iOS.
108108
<p markdown="1" class="pquote-credit">
109109
@KrauseFx, ["Scaling open source communities"](https://krausefx.com/blog/scaling-open-source-communities)
110110
</p>
@@ -236,7 +236,7 @@ If you add tests, make sure to explain how they work in your CONTRIBUTING file.
236236

237237
### Use tools to automate basic maintenance tasks
238238

239-
The good news about maintaining a popular project is that other maintainers have probably faced similar issues and built a solution for it.
239+
The good news about maintaining a popular project is that other maintainers have probably faced similar issues and built a solution for them.
240240

241241
There are a [variety of tools available](https://github.com/showcases/tools-for-open-source) to help automate some aspects of maintenance work. A few examples:
242242

_articles/building-community.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Start with your documentation:
3838

3939
* **When someone new lands on your project, thank them for their interest!** It only takes one negative experience to make someone not want to come back.
4040
* **Be responsive.** If you don't respond to their issue for a month, chances are, they've already forgotten about your project.
41-
* **Be open-minded about the types of contributions you'll accept.** Many contributors start with a bug report or small fix. There are [many ways to contribute](../how-to-contribute/#what-it-means-to-contribute) to a project. Let people help how they want to help.
41+
* **Be open-minded about the types of contributions you'll accept.** Many contributors start with a bug report or a small fix. There are [many ways to contribute](../how-to-contribute/#what-it-means-to-contribute) to a project. Let people help how they want to help.
4242
* **If there's a contribution you disagree with,** thank them for their idea and [explain why](../best-practices/#learning-to-say-no) it doesn't fit into the scope of the project, linking to relevant documentation if you have it.
4343

4444
<aside markdown="1" class="pquote">

_articles/getting-paid.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ related:
1717

1818
## Why some people seek financial support
1919

20-
Much of open source work is volunteered. For example, someone might come across a bug in a project they use and submit a quick fix, or they might enjoy tinkering with an open source project in their spare time.
20+
Much of the open source work is volunteered. For example, someone might come across a bug in a project they use and submit a quick fix, or they might enjoy tinkering with an open source project in their spare time.
2121

2222
<aside markdown="1" class="pquote">
2323
<img src="https://avatars.githubusercontent.com/gvanrossum?s=180" class="pquote-avatar" alt="avatar">
@@ -119,7 +119,7 @@ Finally, sometimes open source projects put bounties on issues that you might co
119119

120120
Beyond arrangements for individual contributors, sometimes projects raise money from companies, individuals, or others to fund ongoing work.
121121

122-
Organizational funding might go towards paying current contributors, covering the costs of running the project (such as hosting fees), or investing into new features or ideas.
122+
Organizational funding might go towards paying current contributors, covering the costs of running the project (such as hosting fees), or investing in new features or ideas.
123123

124124
As open source's popularity increases, finding funding for projects is still experimental, but there are a few common options available.
125125

_articles/how-to-contribute.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,7 @@ Before you open an issue or pull request, or ask a question in chat, keep these
410410
>
411411
> 😢 _"X is broken! Please fix it."_
412412
413-
**Do your homework beforehand.** It's OK not to know things, but show that you tried. Before asking for help, be sure to check a project's README, documentation, issues (open or closed), mailing list, and search the internet for an answer. People will appreciate when you demonstrate that you're trying to learn.
413+
**Do your homework beforehand.** It's OK not to know things, but show that you tried. Before asking for help, be sure to check a project's README, documentation, issues (open or closed), mailing list, and search the internet for an answer. People will appreciate it when you demonstrate that you're trying to learn.
414414

415415
> 😇 _"I'm not sure how to implement X. I checked the help docs and didn't find any mentions."_
416416
>
@@ -494,7 +494,7 @@ If the project is on GitHub, here's how to submit a pull request:
494494
* **Reference any relevant issues** or supporting documentation in your PR (for example, "Closes #37.")
495495
* **Include screenshots of the before and after** if your changes include differences in HTML/CSS. Drag and drop the images into the body of your pull request.
496496
* **Test your changes!** Run your changes against any existing tests if they exist and create new ones when needed. Whether tests exist or not, make sure your changes don't break the existing project.
497-
* **Contribute in the style of the project** to the best of your abilities. This may mean using indents, semi-colons or comments differently than you would in your own repository, but makes it easier for the maintainer to merge, others to understand and maintain in the future.
497+
* **Contribute to the style of the project** to the best of your abilities. This may mean using indents, semi-colons or comments differently than you would in your own repository, but makes it easier for the maintainer to merge, others to understand and maintain in the future.
498498

499499
If this is your first pull request, check out [Make a Pull Request](http://makeapullrequest.com/), which @kentcdodds created as a walkthrough video tutorial. You can also practice making a pull request in the [First Contributions](https://github.com/Roshanjossey/first-contributions) repository, created by @Roshanjossey.
500500

docs/content-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,6 @@ Historical vignettes are fun anecdotes that keep a reader's attention. They make
3939

4040
We use bulleted lists to keep articles approachable and skim-able, and to group examples and checklists. However, avoid:
4141

42-
- Articles consisting almost entirely of lists; lists should enhance narrative rather than serve as the main attraction.
42+
- Articles consisting almost entirely of lists; lists should enhance the narrative rather than serve as the main attraction.
4343
- Exhaustive or canonical lists; follows from above. If such a list is relevant, [link](styleguide.md#content-principles) to one maintained elsewhere.
4444
- Lists consisting of only links; a guide is not an awesome list. Check out how we link to the main awesome list in a list, [for example](https://opensource.guide/how-to-contribute/#you-dont-just-have-to-work-on-software-projects).

docs/personas.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
* Sees self as ultimate decisionmaker
1212

13-
* Still building community reputation
13+
* Still building a community reputation
1414

1515
* Has never open sourced a project before
1616

docs/styleguide.md

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

33
From the GitHub Manual of Style, which this style guide inherits from:
44

5-
> Words are an important part of how software works. Just as we have a style guide for our code, we have a style guide for our tone and our voice. Even though there may be dozens of people creating a product, it should still sound like we speak in one consistent voice.
5+
> Words are an important part of how the software works. Just as we have a style guide for our code, we have a style guide for our tone and our voice. Even though there may be dozens of people creating a product, it should still sound like we speak in one consistent voice.
66
>
77
> In other words, the way we write is just as important as the way we design. Consider these things when writing copy.
88
@@ -11,7 +11,7 @@ Where possible, [automated tests](../test/prose) enforce style rules.
1111
## Content principles
1212
All written content should follow these principles:
1313

14-
* **Approachability:** Don't assume reader has prior knowledge
14+
* **Approachability:** Don't assume the reader has prior knowledge
1515
* **Brevity:** Keep it simple, link to outside content for deeper dives
1616
* **Curation:** Amplify community best practices vs. any individual's point of view
1717

@@ -34,7 +34,7 @@ When referring to a project on GitHub, link to the repository so others can dive
3434
"Guides" is capitalized when referring to the "Open Source Guides", but not when saying "the guide" or "this guide".
3535

3636
- :smile: Welcome to Open Source Guides!
37-
- :smile: The guide is meant to..
37+
- :smile: The guide is meant to...
3838
- :cry: The goal of this Guide is to...
3939

4040
## More guidance

docs/translations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Translations
22

3-
Thanks for your interest in helping translating the guides!
3+
Thanks for your interest in helping to translate the guides!
44

55
## Starting a translation
66

@@ -15,7 +15,7 @@ If there's not, then today is your day to lead this effort! Here's how to start:
1515
1. Create a new directory in `_articles/` for your language e.g. `_articles/es/`, copy each guide from `_articles/` into that folder and translate the content in each guide, except for the field names in the front matter between the `---`s at the top of each file, e.g., `title:` should remain unchanged. Remove the `toc:` fields (they are only used for English).
1616
1. Copy `index.html` to your target language index file e.g. `[_articles/es/index.html](https://github.com/github/opensource.guide/blob/HEAD/_articles/es/index.html)` and update the `lang:` and add the `permalink:` fields. Example: `lang: es` and `permalink: /es/`. All other fields' values must remain unchanged.
1717
1. Run `script/test` and make sure there are no failures with your translation files. Note that you may need to fix broken links.
18-
1. Send a pull request. (You may send a pull request before all steps above are complete: e.g., you may want to ask for help with translations, or getting tests to pass. However your pull request will not be merged until all steps above are complete.)
18+
1. Send a pull request. (You may send a pull request before all steps above are complete: e.g., you may want to ask for help with translations, or getting tests to pass. However, your pull request will not be merged until all steps above are complete.)
1919

2020
Completing an initial translation of the whole site is a fairly large task. One way to break that task up is to work with other translators through pull requests on your fork. Example: [pull requests on fork for German translation](https://github.com/katrinleinweber/opensource.guide/pulls?q=is%3Apr+is%3Aclosed) and corresponding [initial pull request for German translation](https://github.com/github/opensource.guide/pull/577) on this repository. You can also [add collaborators to your fork](https://help.github.com/en/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository) if you'd like to invite other translators to commit directly to your fork and share responsibility for merging pull requests.
2121

0 commit comments

Comments
 (0)