You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _articles/en-US/best-practices.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,8 +67,8 @@ Here are a few rules that are worth writing down:
67
67
68
68
* How a contribution is reviewed and accepted (_Do they need tests? An issue template?_)
69
69
* The types of contributions you'll accept (_Do you only want help with a certain part of your code?_)
70
-
* When it's appropriate to follow up (_ex. "You can expect a response from a maintainer within 7 days. If you haven't heard anything by then, feel free to ping the thread."_)
71
-
* How much time you spend on the project (_ex. "We only spend about 5 hours per week on this project"_)
70
+
* When it's appropriate to follow up (_for example "You can expect a response from a maintainer within 7 days. If you haven't heard anything by then, feel free to ping the thread."_)
71
+
* How much time you spend on the project (_for example "We only spend about 5 hours per week on this project"_)
72
72
73
73
[Jekyll](https://github.com/jekyll/jekyll/tree/master/docs), [CocoaPods](https://github.com/CocoaPods/CocoaPods/wiki/Communication-&-Design-Rules), and [Homebrew](https://github.com/Homebrew/brew/blob/bbed7246bc5c5b7acb8c1d427d10b43e090dfd39/docs/Maintainers-Avoiding-Burnout.md) are several examples of projects with ground rules for maintainers and contributors.
Copy file name to clipboardExpand all lines: _articles/en-US/how-to-contribute.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -193,7 +193,7 @@ Finally, open source projects use the following tools to organize discussion. Re
193
193
194
194
***Issue tracker:** Where people discuss issues related to the project.
195
195
***Pull requests:** Where people discuss and review changes that are in progress.
196
-
***Discussion forums or mailing lists:** Some projects may use these channels for conversational topics (ex._"How do I..."_ or _"What do you think about..."_ instead of bug reports or feature requests). Others use the issue tracker for all conversations.
196
+
***Discussion forums or mailing lists:** Some projects may use these channels for conversational topics (for example_"How do I..."_ or _"What do you think about..."_ instead of bug reports or feature requests). Others use the issue tracker for all conversations.
197
197
***Synchronous chat channel:** Some projects use chat channels (such as Slack or IRC) for casual conversation, collaboration, and quick exchanges.
198
198
199
199
## Finding a project to contribute to
@@ -353,7 +353,7 @@ A project that is friendly and welcoming signals that they will be receptive to
Are people friendly in the issues, discussion forum, and chat (ex. IRC or Slack)?
356
+
Are people friendly in the issues, discussion forum, and chat (for example IRC or Slack)?
357
357
</label>
358
358
</div>
359
359
@@ -462,7 +462,7 @@ If you want to make a substantial contribution, open an issue to ask before work
462
462
You should usually open an issue in the following situations:
463
463
464
464
* Report an error you can't solve yourself
465
-
* Discuss a high-level topic or idea (ex. community, vision, policies)
465
+
* Discuss a high-level topic or idea (for example community, vision, policies)
466
466
* Propose a new feature or other project idea
467
467
468
468
Tips for communicating on issues:
@@ -475,7 +475,7 @@ Tips for communicating on issues:
475
475
476
476
You should usually open a pull request in the following situations:
477
477
478
-
* Submit trivial fixes (ex. a typo, broken link, or obvious error)
478
+
* Submit trivial fixes (for example a typo, broken link, or obvious error)
479
479
* Start work on a contribution that was already asked for, or that you've already discussed, in an issue
480
480
481
481
A pull request doesn't have to represent finished work. It's usually better to open a pull request early on, so others can watch or give feedback on your progress. Just mark it as a "WIP" (Work in Progress) in the subject line. You can always add more commits later.
@@ -484,7 +484,7 @@ If the project is on GitHub, here's how to submit a pull request:
484
484
485
485
***[Fork the repository](https://guides.github.com/activities/forking/)** and clone it locally. Connect your local to the original "upstream" repository by adding it as a remote. Pull in changes from "upstream" often so that you stay up to date so that when you submit your pull request, merge conflicts will be less likely. (See more detailed instructions [here](https://help.github.com/articles/syncing-a-fork/).)
486
486
***[Create a branch](https://guides.github.com/introduction/flow/)** for your edits.
487
-
***Reference any relevant issues** or supporting documentation in your PR (ex. "Closes #37.")
487
+
***Reference any relevant issues** or supporting documentation in your PR (for example "Closes #37.")
488
488
***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.
489
489
***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.
490
490
***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.
Copy file name to clipboardExpand all lines: _articles/en-US/leadership-and-governance.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -66,7 +66,7 @@ For a smaller project, designating leaders can be as simple as adding their name
66
66
67
67
For a bigger project, if you have a website, create a team page or list your project leaders there. For example, [Postgres](https://github.com/postgres/postgres/) has a [comprehensive team page](https://www.postgresql.org/community/contributors/) with short profiles for each contributor.
68
68
69
-
If your project has a very active contributor community, you might form a "core team" of maintainers, or even subcommittees of people who take ownership of different issue areas (ex. security, issue triaging, or community conduct). Let people self-organize and volunteer for the roles they're most excited about, rather than assigning them.
69
+
If your project has a very active contributor community, you might form a "core team" of maintainers, or even subcommittees of people who take ownership of different issue areas (for example security, issue triaging, or community conduct). Let people self-organize and volunteer for the roles they're most excited about, rather than assigning them.
70
70
71
71
<asidemarkdown="1"class="pquote">
72
72
\[We\] supplement the core team with several "subteams". Each subteam is focused on a specific area, e.g., language design or libraries. (...) To ensure global coordination and a strong, coherent vision for the project as a whole, each subteam is led by a member of the core team.
Copy file name to clipboardExpand all lines: _articles/en-US/starting-a-project.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -230,7 +230,7 @@ Pick a name that is easy to remember and, ideally, gives some idea of what the p
230
230
*[Sentry](https://github.com/getsentry/sentry) monitors apps for crash reporting
231
231
*[Thin](https://github.com/macournoyer/thin) is a fast and simple Ruby web server
232
232
233
-
If you're building upon an existing project, using their name as a prefix can help clarify what your project does (ex.[node-fetch](https://github.com/bitinn/node-fetch) brings `window.fetch` to Node.js).
233
+
If you're building upon an existing project, using their name as a prefix can help clarify what your project does (for example[node-fetch](https://github.com/bitinn/node-fetch) brings `window.fetch` to Node.js).
234
234
235
235
Consider clarity above all. Puns are fun, but remember that some jokes might not translate to other cultures or people with different experiences from you. Some of your potential users might be company employees: you don't want to make them uncomfortable when they have to explain your project at work!
236
236
@@ -319,7 +319,7 @@ Ready to open source your project? Here's a checklist to help. Check all the box
0 commit comments