Skip to content

Commit 09e7bfe

Browse files
committed
Update generated docs for 3.11.0
1 parent 50bb748 commit 09e7bfe

File tree

7 files changed

+547
-0
lines changed

7 files changed

+547
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
30+
* Other conduct which could reasonably be considered inappropriate in a professional setting
31+
32+
## Our Responsibilities
33+
34+
Project maintainers are responsible for clarifying the standards of acceptable
35+
behavior and are expected to take appropriate and fair corrective action in
36+
response to any instances of unacceptable behavior.
37+
38+
Project maintainers have the right and responsibility to remove, edit, or
39+
reject comments, commits, code, wiki edits, issues, and other contributions
40+
that are not aligned to this Code of Conduct, or to ban temporarily or
41+
permanently any contributor for other behaviors that they deem inappropriate,
42+
threatening, offensive, or harmful.
43+
44+
## Scope
45+
46+
This Code of Conduct applies both within project spaces and in public spaces
47+
when an individual is representing the project or its community. Examples of
48+
representing a project or community include using an official project e-mail
49+
address, posting via an official social media account, or acting as an appointed
50+
representative at an online or offline event. Representation of a project may be
51+
further defined and clarified by project maintainers.
52+
53+
## Enforcement
54+
55+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
56+
reported by contacting the project team at [email protected]. All
57+
complaints will be reviewed and investigated and will result in a response that
58+
is deemed necessary and appropriate to the circumstances. The project team is
59+
obligated to maintain confidentiality with regard to the reporter of an incident.
60+
Further details of specific enforcement policies may be posted separately.
61+
62+
Project maintainers who do not follow or enforce the Code of Conduct in good
63+
faith may face temporary or permanent repercussions as determined by other
64+
members of the project's leadership.
65+
66+
## Attribution
67+
68+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
69+
available at [http://contributor-covenant.org/version/1/4][version]
70+
71+
[homepage]: http://contributor-covenant.org
72+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Contributing
2+
3+
Hi there! We're thrilled that you'd like to contribute to this project. However since this project is released as part of the GitHub Enterprise Server product and is maintained by GitHub staff we are currently not accepting public contributions to its development.

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 GitHub
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

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

33
This is the management tool for GitHub Enterprise Server (GHES) on the command line.
44

5+
## Installation
6+
7+
`gh es` is available for installation as a `gh` CLI extension, and as a downloadable binary from the [releases page](https://github.com/github/gh-es/releases/latest).
8+
9+
In order to use it as a [CLI extension](https://cli.github.com/manual/gh_extension_install), you must have the GitHub CLI [installed](https://github.com/cli/cli/#installation).
10+
11+
To install the latest version, use:
12+
13+
```bash
14+
gh extension install github.com/github/gh-es
15+
```
16+
17+
Please make sure to install the correct version of the CLI extension which matches the release version (e.g. `3.11`) of your GHES installation, by pinning to the latest patch for the corresponding release series:
18+
19+
```bash
20+
gh extension install github.com/github/gh-es --pin v3.11.0
21+
```
22+
23+
## Usage
24+
25+
For more information on how to use the CLI and its commands, please see the [USAGE](./USAGE.md) documentation.
26+
27+
## License
28+
29+
This project is licensed under the terms of the MIT open source license. Please refer to [LICENSE](./LICENSE.md) for the full terms.
30+
31+
## Support
32+
33+
See [SUPPORT](./SUPPORT.md).
34+
35+
## Contributing
36+
37+
See [CONTRIBUTING](./CONTRIBUTING.md).

SECURITY.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Security
2+
3+
GitHub takes the security of our software products and services seriously, including all of the open source code repositories managed through our GitHub organizations, such as [GitHub](https://github.com/GitHub).
4+
5+
Even though [open source repositories are outside of the scope of our bug bounty program](https://bounty.github.com/index.html#scope) and therefore not eligible for bounty rewards, we will ensure that your finding gets passed along to the appropriate maintainers for remediation.
6+
7+
## Reporting Security Issues
8+
9+
If you believe you have found a security vulnerability in any GitHub-owned repository, please report it to us through coordinated disclosure.
10+
11+
**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.**
12+
13+
Instead, please send an email to opensource-security[@]github.com.
14+
15+
Please include as much of the information listed below as you can to help us better understand and resolve the issue:
16+
17+
* The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting)
18+
* Full paths of source file(s) related to the manifestation of the issue
19+
* The location of the affected source code (tag/branch/commit or direct URL)
20+
* Any special configuration required to reproduce the issue
21+
* Step-by-step instructions to reproduce the issue
22+
* Proof-of-concept or exploit code (if possible)
23+
* Impact of the issue, including how an attacker might exploit the issue
24+
25+
This information will help us triage your report more quickly.
26+
27+
## Policy
28+
29+
See [GitHub's Safe Harbor Policy](https://docs.github.com/en/github/site-policy/github-bug-bounty-program-legal-safe-harbor#1-safe-harbor-terms)

SUPPORT.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Support
2+
3+
## How to file issues and get help
4+
5+
For help or questions about using this `gh` CLI extension, please contact your GitHub representative.
6+
7+
The CLI extension is maintained by GitHub staff. We will do our best to respond to support, feature requests, and community questions in a timely manner.
8+
9+
If you have a question related to your specific GitHub Enterprise Server when using the `gh es` CLI extension please [contact our Enterprise support](https://support.github.com) team.
10+
11+
## GitHub Support Policy
12+
13+
Support for this project is limited to the resources listed above.

0 commit comments

Comments
 (0)