Skip to content

Commit 874e988

Browse files
committed
Merge 'readme' into HEAD
Add a README.md for GitHub goodness. Signed-off-by: Johannes Schindelin <[email protected]>
2 parents 6077cdb + 75db731 commit 874e988

8 files changed

+772
-59
lines changed

.github/ISSUE_TEMPLATE.md

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
- [ ] I was not able to find an [open](https://github.com/git-for-windows/git/issues?q=is%3Aopen) or [closed](https://github.com/git-for-windows/git/issues?q=is%3Aclosed) issue matching what I'm seeing
2+
3+
### Setup
4+
5+
- Which version of Git for Windows are you using? Is it 32-bit or 64-bit?
6+
7+
```
8+
$ git --version --build-options
9+
10+
** insert your machine's response here **
11+
```
12+
13+
- Which version of Windows are you running? Vista, 7, 8, 10? Is it 32-bit or 64-bit?
14+
15+
```
16+
$ cmd.exe /c ver
17+
18+
** insert your machine's response here **
19+
```
20+
21+
- What options did you set as part of the installation? Or did you choose the
22+
defaults?
23+
24+
```
25+
# One of the following:
26+
> type "C:\Program Files\Git\etc\install-options.txt"
27+
> type "C:\Program Files (x86)\Git\etc\install-options.txt"
28+
> type "%USERPROFILE%\AppData\Local\Programs\Git\etc\install-options.txt"
29+
> type "$env:USERPROFILE\AppData\Local\Programs\Git\etc\install-options.txt"
30+
$ cat /etc/install-options.txt
31+
32+
** insert your machine's response here **
33+
```
34+
35+
- Any other interesting things about your environment that might be related
36+
to the issue you're seeing?
37+
38+
** insert your response here **
39+
40+
### Details
41+
42+
- Which terminal/shell are you running Git from? e.g Bash/CMD/PowerShell/other
43+
44+
** insert your response here **
45+
46+
- What commands did you run to trigger this issue? If you can provide a
47+
[Minimal, Complete, and Verifiable example](http://stackoverflow.com/help/mcve)
48+
this will help us understand the issue.
49+
50+
```
51+
** insert your commands here **
52+
```
53+
- What did you expect to occur after running these commands?
54+
55+
** insert here **
56+
57+
- What actually happened instead?
58+
59+
** insert here **
60+
61+
- If the problem was occurring with a specific repository, can you provide the
62+
URL to that repository to help us with testing?
63+
64+
** insert URL here **

.github/PULL_REQUEST_TEMPLATE.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,19 @@
1-
Thanks for taking the time to contribute to Git! Please be advised that the
2-
Git community does not use github.com for their contributions. Instead, we use
3-
a mailing list ([email protected]) for code submissions, code reviews, and
4-
bug reports. Nevertheless, you can use GitGitGadget (https://gitgitgadget.github.io/)
1+
Thanks for taking the time to contribute to Git!
2+
3+
Those seeking to contribute to the Git for Windows fork should see
4+
http://gitforwindows.org/#contribute on how to contribute Windows specific
5+
enhancements.
6+
7+
If your contribution is for the core Git functions and documentation
8+
please be aware that the Git community does not use the github.com issues
9+
or pull request mechanism for their contributions.
10+
11+
Instead, we use the Git mailing list ([email protected]) for code and
12+
documentation submissions, code reviews, and bug reports. The
13+
mailing list is plain text only (anything with HTML is sent directly
14+
to the spam folder).
15+
16+
Nevertheless, you can use GitGitGadget (https://gitgitgadget.github.io/)
517
to conveniently send your Pull Requests commits to our mailing list.
618

719
For a single-commit pull request, please *leave the pull request description

ARCHITECTURE.md

+130
Large diffs are not rendered by default.

CODE_OF_CONDUCT.md

+26-32
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Git Code of Conduct
1+
# Git for Windows Code of Conduct
22

33
This code of conduct outlines our expectations for participants within
4-
the Git community, as well as steps for reporting unacceptable behavior.
5-
We are committed to providing a welcoming and inspiring community for
6-
all and expect our code of conduct to be honored. Anyone who violates
4+
the **Git for Windows** community, as well as steps for reporting unacceptable
5+
behavior. We are committed to providing a welcoming and inspiring community
6+
for all and expect our code of conduct to be honored. Anyone who violates
77
this code of conduct may be banned from the community.
88

99
## Our Pledge
@@ -12,8 +12,8 @@ We as members, contributors, and leaders pledge to make participation in our
1212
community a harassment-free experience for everyone, regardless of age, body
1313
size, visible or invisible disability, ethnicity, sex characteristics, gender
1414
identity and expression, level of experience, education, socio-economic status,
15-
nationality, personal appearance, race, religion, or sexual identity
16-
and orientation.
15+
nationality, personal appearance, race, caste, color, religion, or sexual
16+
identity and orientation.
1717

1818
We pledge to act and interact in ways that contribute to an open, welcoming,
1919
diverse, inclusive, and healthy community.
@@ -28,17 +28,17 @@ community include:
2828
* Giving and gracefully accepting constructive feedback
2929
* Accepting responsibility and apologizing to those affected by our mistakes,
3030
and learning from the experience
31-
* Focusing on what is best not just for us as individuals, but for the
32-
overall community
31+
* Focusing on what is best not just for us as individuals, but for the overall
32+
community
3333

3434
Examples of unacceptable behavior include:
3535

36-
* The use of sexualized language or imagery, and sexual attention or
37-
advances of any kind
36+
* The use of sexualized language or imagery, and sexual attention or advances of
37+
any kind
3838
* Trolling, insulting or derogatory comments, and personal or political attacks
3939
* Public or private harassment
40-
* Publishing others' private information, such as a physical or email
41-
address, without their explicit permission
40+
* Publishing others' private information, such as a physical or email address,
41+
without their explicit permission
4242
* Other conduct which could reasonably be considered inappropriate in a
4343
professional setting
4444

@@ -58,20 +58,14 @@ decisions when appropriate.
5858

5959
This Code of Conduct applies within all community spaces, and also applies when
6060
an individual is officially representing the community in public spaces.
61-
Examples of representing our community include using an official e-mail address,
61+
Examples of representing our community include using an official email address,
6262
posting via an official social media account, or acting as an appointed
6363
representative at an online or offline event.
6464

6565
## Enforcement
6666

6767
Instances of abusive, harassing, or otherwise unacceptable behavior may be
68-
reported to the community leaders responsible for enforcement at
69-
[email protected], or individually:
70-
71-
- Ævar Arnfjörð Bjarmason <[email protected]>
72-
- Christian Couder <[email protected]>
73-
- Junio C Hamano <[email protected]>
74-
- Taylor Blau <[email protected]>
68+
reported by contacting the Git for Windows maintainer.
7569

7670
All complaints will be reviewed and investigated promptly and fairly.
7771

@@ -94,15 +88,15 @@ behavior was inappropriate. A public apology may be requested.
9488

9589
### 2. Warning
9690

97-
**Community Impact**: A violation through a single incident or series
98-
of actions.
91+
**Community Impact**: A violation through a single incident or series of
92+
actions.
9993

10094
**Consequence**: A warning with consequences for continued behavior. No
10195
interaction with the people involved, including unsolicited interaction with
10296
those enforcing the Code of Conduct, for a specified period of time. This
10397
includes avoiding interactions in community spaces as well as external channels
104-
like social media. Violating these terms may lead to a temporary or
105-
permanent ban.
98+
like social media. Violating these terms may lead to a temporary or permanent
99+
ban.
106100

107101
### 3. Temporary Ban
108102

@@ -118,27 +112,27 @@ Violating these terms may lead to a permanent ban.
118112
### 4. Permanent Ban
119113

120114
**Community Impact**: Demonstrating a pattern of violation of community
121-
standards, including sustained inappropriate behavior, harassment of an
115+
standards, including sustained inappropriate behavior, harassment of an
122116
individual, or aggression toward or disparagement of classes of individuals.
123117

124-
**Consequence**: A permanent ban from any sort of public interaction within
125-
the community.
118+
**Consequence**: A permanent ban from any sort of public interaction within the
119+
community.
126120

127121
## Attribution
128122

129123
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
130-
version 2.0, available at
131-
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
124+
version 2.1, available at
125+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
132126

133127
Community Impact Guidelines were inspired by
134128
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
135129

136130
For answers to common questions about this code of conduct, see the FAQ at
137-
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
138-
at [https://www.contributor-covenant.org/translations][translations].
131+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
132+
[https://www.contributor-covenant.org/translations][translations].
139133

140134
[homepage]: https://www.contributor-covenant.org
141-
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
135+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
142136
[Mozilla CoC]: https://github.com/mozilla/diversity
143137
[FAQ]: https://www.contributor-covenant.org/faq
144138
[translations]: https://www.contributor-covenant.org/translations

0 commit comments

Comments
 (0)