Skip to content

Commit 06a8893

Browse files
Move
1 parent c34137a commit 06a8893

File tree

7 files changed

+31
-58
lines changed

7 files changed

+31
-58
lines changed

.github/.github/SECURITY.md

Lines changed: 0 additions & 45 deletions
This file was deleted.
File renamed without changes.
Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,13 @@
44

55
# Welcome to GitHub docs contributing guide <!-- omit in toc -->
66

7-
Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [docs.github.com](https://docs.github.com/en) :sparkles:.
7+
Thank you for investing your time in contributing to this project!
88

9+
Before you get started, please review the following guidelines:
910
Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
1011

1112
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
1213

13-
Use the table of contents icon <img src="./assets/images/table-of-contents.png" width="25" height="25" /> on the top left corner of this document to get to a specific section of this guide quickly.
14-
1514
## New contributor guide
1615

1716
To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions:
@@ -21,28 +20,33 @@ To get an overview of the project, read the [README](README.md). Here are some r
2120
- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow)
2221
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
2322

24-
2523
## Getting started
2624

27-
To navigate our codebase with confidence, see [the introduction to working in the docs repository](/contributing/working-in-docs-repository.md) :confetti_ball:. For more information on how we write our markdown files, see [the GitHub Markdown reference](contributing/content-markup-reference.md).
25+
To navigate our codebase with confidence, see [the introduction to working in the docs repository](/contributing/working-in-docs-repository.md) :confetti_ball:.
26+
For more information on how we write our markdown files, see [the GitHub Markdown reference](contributing/content-markup-reference.md).
2827

29-
Check to see what [types of contributions](/contributing/types-of-contributions.md) we accept before making changes. Some of them don't even require writing a single line of code :sparkles:.
28+
Check to see what [types of contributions](/contributing/types-of-contributions.md) we accept before making changes.
29+
Some of them don't even require writing a single line of code :sparkles:.
3030

3131
### Issues
3232

3333
#### Create a new issue
3434

35-
If you spot a problem with the docs, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/github/docs/issues/new/choose).
35+
If you spot a problem with the docs, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments).
36+
If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/github/docs/issues/new/choose).
3637

3738
#### Solve an issue
3839

39-
Scan through our [existing issues](https://github.com/github/docs/issues) to find one that interests you. You can narrow down the search using `labels` as filters. See [Labels](/contributing/how-to-use-labels.md) for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
40+
Scan through our [existing issues](https://github.com/github/docs/issues) to find one that interests you.
41+
You can narrow down the search using `labels` as filters. See [Labels](/contributing/how-to-use-labels.md) for more information.
42+
As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
4043

4144
### Make Changes
4245

4346
#### Make changes in the UI
4447

45-
Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review.
48+
Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link.
49+
This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review.
4650

4751
<img src="./assets/images/contribution_cta.png" width="300" height="150" />
4852

@@ -52,22 +56,26 @@ Click **Make a contribution** at the bottom of any docs page to make small chang
5256

5357
2. Fork the repository.
5458
- Using GitHub Desktop:
55-
- [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop.
59+
- [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop)
60+
will guide you through setting up Desktop.
5661
- Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)!
5762

5863
- Using the command line:
59-
- [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.
64+
- [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make
65+
your changes without affecting the original project until you're ready to merge them.
6066

6167
- GitHub Codespaces:
62-
- [Fork, edit, and preview](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace) using [GitHub Codespaces](https://github.com/features/codespaces) without having to install and run the project locally.
68+
- [Fork, edit, and preview](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace)
69+
using [GitHub Codespaces](https://github.com/features/codespaces) without having to install and run the project locally.
6370

6471
3. Install or update to **Node.js v16**. For more information, see [the development guide](contributing/development.md).
6572

6673
4. Create a working branch and start with your changes!
6774

6875
### Commit your update
6976

70-
Commit the changes once you are happy with them. See [Atom's contributing guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages) to know how to use emoji for commit messages.
77+
Commit the changes once you are happy with them. See [Atom's contributing guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages)
78+
to know how to use emoji for commit messages.
7179

7280
Once your changes are ready, don't forget to [self-review](/contributing/self-review.md) to speed up the review process:zap:.
7381

.github/SECURITY.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Only the latest version of this module is supported. If a fix is made, it will only be added to the latest version.
6+
7+
## Reporting a security issue
8+
9+
If a security issue is found please do not make a public issue, as this could put other users at risk.
10+
Instead, please mail us on [[email protected]](mailto:[email protected]).
File renamed without changes.

0 commit comments

Comments
 (0)