Skip to content

Commit 8d13ef3

Browse files
authored
Reflow of all markdown files (#343)
* Should now all have a consistent right margin. - This allows side by Side preview that doesn't hide text when the solution explorer is hidden. * Minor clarifications, corrections to some document contents.
1 parent b378657 commit 8d13ef3

File tree

50 files changed

+2123
-2040
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+2123
-2040
lines changed

CODE_OF_CONDUCT.md

Lines changed: 31 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22

33
## Our Pledge
44

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

1011
## Our Standards
1112

@@ -22,39 +23,47 @@ Examples of unacceptable behavior by participants include:
2223
* The use of sexualized language or imagery and unwelcome sexual attention or advances
2324
* Trolling, insulting/derogatory comments, and personal or political attacks
2425
* Public or private harassment
25-
* Publishing others' private information, such as a physical or electronic address, without explicit permission
26+
* Publishing others' private information, such as a physical or electronic address, without
27+
explicit permission
2628
* Other conduct which could reasonably be considered inappropriate in a professional setting
2729

2830
## Our Responsibilities
2931

30-
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate
31-
and fair corrective action in response to any instances of unacceptable behavior.
32+
Project maintainers are responsible for clarifying the standards of acceptable behavior and
33+
are expected to take appropriate and fair corrective action in response to any instances of
34+
unacceptable behavior.
3235

33-
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues,
34-
and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor
35-
for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
36+
Project maintainers have the right and responsibility to remove, edit, or reject comments,
37+
commits, code, wiki edits, issues, and other contributions that are not aligned to this Code
38+
of Conduct, or to ban temporarily or permanently any contributor for other behaviors that
39+
they deem inappropriate, threatening, offensive, or harmful.
3640

3741
## Scope
3842

39-
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project
40-
or its community. Examples of representing a project or community include using an official project e-mail address, posting
41-
via an official social media account, or acting as an appointed representative at an on-line or off-line event. Representation
42-
of a project may be further defined and clarified by project maintainers.
43+
This Code of Conduct applies both within project spaces and in public spaces when an
44+
individual is representing the project or its community. Examples of representing a project
45+
or community include using an official project e-mail address, posting via an official
46+
social media account, or acting as an appointed representative at an on-line or off-line
47+
event. Representation of a project may be further defined and clarified by project
48+
maintainers.
4349

4450
## Enforcement
4551

46-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
47-
osscodeofconduct@telliam.com. The project team will review and investigate all complaints, and will respond in a way that
48-
it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the
49-
reporter of an incident. Further details of specific enforcement policies may be posted separately.
52+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
53+
contacting the project team at osscodeofconduct@telliam.com. The project team will review
54+
and investigate all complaints, and will respond in a way that it deems appropriate to the
55+
circumstances. The project team is obligated to maintain confidentiality with regard to the
56+
reporter of an incident. Further details of specific enforcement policies may be posted
57+
separately.
5058

51-
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions
52-
as determined by other members of the project's leadership.
59+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face
60+
temporary or permanent repercussions as determined by other members of the project's
61+
leadership.
5362

5463
## Attribution
5564

56-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at
57-
[http://contributor-covenant.org/version/1/4][version]
65+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
66+
available at [http://contributor-covenant.org/version/1/4][version]
5867

5968
[homepage]: http://contributor-covenant.org
6069
[version]: http://contributor-covenant.org/version/1/4/

GOVERNANCE.md

Lines changed: 79 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -3,60 +3,67 @@ This document describes the governance model for this project.
33
(This is adapted from the template provided by http://oss-watch.ac.uk/resources/benevolentdictatorgovernancemodel )
44

55
## Overview
6-
This project is led by a benevolent dictator and managed by the community. That is, the community actively contributes
7-
to the day-to-day maintenance of the project, but the general strategic line is drawn by the benevolent dictator. In
8-
case of disagreement, they have the last word. It is the benevolent dictator's job to resolve disputes within the
9-
community and to ensure that the project is able to progress in a coordinated way. In turn, it is the community's job
10-
to guide the decisions of the benevolent dictator through active engagement and contribution.
6+
This project is led by a benevolent dictator and managed by the community. That is, the
7+
community actively contributes to the day-to-day maintenance of the project, but the general
8+
strategic line is drawn by the benevolent dictator. In case of disagreement, they have the
9+
last word. It is the benevolent dictator's job to resolve disputes within the community and
10+
to ensure that the project is able to progress in a coordinated way. In turn, it is the
11+
community's job to guide the decisions of the benevolent dictator through active engagement
12+
and contribution.
1113

1214
## Roles and responsibilities
1315
### Benevolent dictator (project lead)
1416

15-
Typically, the benevolent dictator, or project lead, is self-appointed. However, because the community always has the
16-
ability to fork, this person is fully answerable to the community. The project lead's role is a
17-
[difficult one](http://producingoss.com/html-chunk/social-infrastructure.html#benevolent-dictator-qualifications): they
18-
set the strategic objectives of the project and communicate these clearly to the community. They also have to understand
19-
the community as a whole and strive to satisfy as many conflicting needs as possible, while ensuring that the project
20-
survives in the long term.
21-
22-
In many ways, the role of the benevolent dictator is less about dictatorship and more about diplomacy. The key is to
23-
ensure that, as the project expands, the right people are given influence over it and the community rallies behind the
24-
vision of the project lead. The lead's job is then to ensure that the committers (see below) make the right decisions
25-
on behalf of the project. Generally speaking, as long as the committers are aligned with the project's strategy, the
26-
project lead will allow them to proceed as they desire.
17+
Typically, the benevolent dictator, or project lead, is self-appointed. However, because the
18+
community always has the ability to fork, this person is fully answerable to the community.
19+
The project lead's role is a [difficult one](http://producingoss.com/html-chunk/social-infrastructure.html#benevolent-dictator-qualifications):
20+
they set the strategic objectives of the project and communicate these clearly to the
21+
community. They also have to understand the community as a whole and strive to satisfy as
22+
many conflicting needs as possible, while ensuring that the project survives in the long
23+
term.
24+
25+
In many ways, the role of the benevolent dictator is less about dictatorship and more about
26+
diplomacy. The key is to ensure that, as the project expands, the right people are given
27+
influence over it and the community rallies behind the vision of the project lead. The
28+
lead's job is then to ensure that the committers (see below) make the right decisions on
29+
behalf of the project. Generally speaking, as long as the committers are aligned with the
30+
project's strategy, the project lead will allow them to proceed as they desire.
2731

2832
### Committers
2933

30-
Committers are contributors who have made several valuable contributions to the project and are now relied upon to
31-
both write code directly to the repository and screen the contributions of others. In many cases they are programmers
32-
but it is also possible that they contribute in a different role. Typically, a committer will focus on a specific aspect
33-
of the project, and will bring a level of expertise and understanding that earns them the respect of the community and
34-
the project lead. The role of committer is not an official one, it is simply a position that influential members of the
35-
community will find themselves in as the project lead looks to them for guidance and support.
36-
37-
Committers have no authority over the overall direction of the project. However, they do have the ear of the project
38-
lead. It is a committer's job to ensure that the lead is aware of the community's needs and collective objectives, and
39-
to help develop or elicit appropriate contributions to the project. Often, committers are given informal control over
40-
their specific areas of responsibility, and are assigned rights to directly modify certain areas of the source code.
41-
That is, although committers do not have explicit decision-making authority, they will often find that their actions
42-
are synonymous with the decisions made by the lead.
34+
Committers are contributors who have made several valuable contributions to the project and
35+
are now relied upon to both write code directly to the repository and screen the
36+
contributions of others. In many cases they are programmers but it is also possible that
37+
they contribute in a different role. Typically, a committer will focus on a specific aspect
38+
of the project, and will bring a level of expertise and understanding that earns them the
39+
respect of the community and the project lead. The role of committer is not an official one,
40+
it is simply a position that influential members of the community will find themselves in as
41+
the project lead looks to them for guidance and support.
42+
43+
Committers have no authority over the overall direction of the project. However, they do
44+
have the ear of the project lead. It is a committer's job to ensure that the lead is aware
45+
of the community's needs and collective objectives, and to help develop or elicit
46+
appropriate contributions to the project. Often, committers are given informal control over
47+
their specific areas of responsibility, and are assigned rights to directly modify certain
48+
areas of the source code. That is, although committers do not have explicit decision-making
49+
authority, they will often find that their actions are synonymous with the decisions made by
50+
the lead.
4351

4452
### Contributors
4553

46-
Contributors are community members who either have no desire to become committers, or have not yet been given the
47-
opportunity by the benevolent dictator. They make valuable contributions, such as those outlined in the list below,
48-
but generally do not have the authority to make direct changes to the project code. Contributors engage with the
49-
project through communication tools, such as email lists, and via reports and
50-
[patches](http://oss-watch.ac.uk/resources/softwarepatch) attached to issues in the issue tracker, as detailed in
51-
our [community tools document](http://oss-watch.ac.uk/resources/communitytools).
52-
53-
Anyone can become a contributor. There is no expectation of commitment to the project, no specific skill requirements
54-
and no selection process. To become a contributor, a community member simply has to perform one or more actions that
55-
are beneficial to the project.
54+
Contributors are community members who either have no desire to become committers, or have
55+
not yet been given the opportunity by the benevolent dictator. They make valuable
56+
contributions, such as those outlined in the list below, but generally do not have the
57+
authority to make direct changes to the project code. Contributors engage with the project
58+
through communication tools, such as email lists, and via reports and [patches](http://oss-watch.ac.uk/resources/softwarepatch)
59+
attached to issues in the issue tracker, as detailed in our [community tools document](http://oss-watch.ac.uk/resources/communitytools).
5660

57-
Some contributors will already be engaging with the project as users, but will also find themselves doing one or more
58-
of the following:
61+
Anyone can become a contributor. There is no expectation of commitment to the project, no
62+
specific skill requirements and no selection process. To become a contributor, a community
63+
member simply has to perform one or more actions that are beneficial to the project.
5964

65+
Some contributors will already be engaging with the project as users, but will also find
66+
themselves doing one or more of the following:
6067
* Supporting new users (current users often provide the most effective new user support)
6168
* Reporting bugs
6269
* Identifying requirements
@@ -67,44 +74,52 @@ of the following:
6774
* Fixing bugs
6875
* Adding features
6976

70-
As contributors gain experience and familiarity with the project, they may find that the project lead starts relying
71-
on them more and more. When this begins to happen, they gradually adopt the role of committer, as described above.
77+
As contributors gain experience and familiarity with the project, they may find that the
78+
project lead starts relying on them more and more. When this begins to happen, they
79+
gradually adopt the role of committer, as described above.
7280

7381
### Users
7482

75-
Users are community members who have a need for the project. They are the most important members of the community:
76-
without them, the project would have no purpose. Anyone can be a user; there are no specific requirements.
83+
Users are community members who have a need for the project. They are the most important
84+
members of the community:
85+
without them, the project would have no purpose. Anyone can be a user; there are no specific
86+
requirements.
7787

78-
Users should be encouraged to participate in the life of the project and the community as much as possible. User
79-
contributions enable the project team to ensure that they are satisfying the needs of those users. Common user
80-
activities include (but are not limited to):
88+
Users should be encouraged to participate in the life of the project and the community as
89+
much as possible. User contributions enable the project team to ensure that they are
90+
satisfying the needs of those users. Common user activities include (but are not limited to):
8191

8292
* Evangelizing about the project
8393
* Informing developers of project strengths and weaknesses from a new user's perspective
8494
* Providing moral support (a 'thank you' goes a long way)
8595
* Providing financial support
8696

87-
Users who continue to engage with the project and its community will often find themselves becoming more and more
88-
involved. Such users may then go on to become contributors, as described above.
97+
Users who continue to engage with the project and its community will often find themselves
98+
becoming more and more involved. Such users may then go on to become contributors, as
99+
described above.
89100

90101
### Support
91102

92-
All participants in the community are encouraged to provide support for new users within the project management
93-
infrastructure. This support is provided as a way of growing the community. Those seeking support should recognize that
94-
all support activity within the project is voluntary and is therefore provided as and when time allows. A user requiring
95-
guaranteed response times or results should therefore seek to purchase a support contract from a vendor. (Of course,
96-
that vendor should be an active member of the community.) However, for those willing to engage with the project on its
97-
own terms, and willing to help support other users, the community support channels are ideal.
103+
All participants in the community are encouraged to provide support for new users within the
104+
project management infrastructure. This support is provided as a way of growing the
105+
community. Those seeking support should recognize that all support activity within the
106+
project is voluntary and is therefore provided as and when time allows. A user requiring
107+
guaranteed response times or results should therefore seek to purchase a support contract
108+
from a vendor. (Of course, that vendor should be an active member of the community.)
109+
However, for those willing to engage with the project on its own terms, and willing to help
110+
support other users, the community support channels are ideal.
98111

99112
### Contribution process
100113

101-
Anyone can contribute to the project, regardless of their skills, as there are many ways to contribute. For instance, a
102-
contributor might be active on the project mailing list and issue tracker, or might supply
103-
[patches](http://oss-watch.ac.uk/resources/softwarepatch). The various ways of contributing are described in more detail
104-
in our [roles in open source document](http://oss-watch.ac.uk/resources/rolesinopensource).
114+
Anyone can contribute to the project, regardless of their skills, as there are many ways to
115+
contribute. For instance, a contributor might be active on the project mailing list and
116+
issue tracker, or might supply [patches](http://oss-watch.ac.uk/resources/softwarepatch).
117+
The various ways of contributing are described in more detail in our
118+
[roles in open source document](http://oss-watch.ac.uk/resources/rolesinopensource).
105119

106120
### Decision-making process
107121

108-
The benevolent dictatorship model does not need a formal conflict resolution process, since the project lead's word is
109-
final. If the community chooses to question the wisdom of the actions of a committer, the project lead can review their
110-
decisions by checking the communication archives, and either uphold or reverse them.
122+
The benevolent dictatorship model does not need a formal conflict resolution process, since
123+
the project lead's word is final. If the community chooses to question the wisdom of the
124+
actions of a committer, the project lead can review their decisions by checking the
125+
communication archives, and either uphold or reverse them.

OneFlow/ReadMe.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# GIT OneFlow support scripts
22
The scripts in this folder are used for release and feature branch management.
33
This repository follows the [OneFlow](https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow#develop-finishing-a-release-branch)
4-
model and work-flow. With one active long term branch 'develop'. The master
5-
branch is present and long term but is not active, it only points to the latest
6-
official release (including preview releases) of the project. This is a convenience
7-
to allow getting the latests released source quickly. Generally the scripts used here
8-
are only for release managers and are not required (or even an option) for most contributors.
4+
model and work-flow. With one active long term branch 'develop'. The master branch is
5+
present and long term but is not active, it only points to the latest official release
6+
(including preview releases) of the project. This is a convenience to allow getting the
7+
latests released source quickly. Generally the scripts used here are only for release
8+
managers and are not required (or even an option) for most contributors.

docfx/CommandLine/api/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# About
2-
Ubiquity.NET.CommandLines contains general extensions for .NET. to support command line
2+
`Ubiquity.NET.CommandLine` contains general extensions for .NET. to support command line
33
parsing using `System.CommandLine`

0 commit comments

Comments
 (0)