Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 24199f6

Browse files
authored
Merge pull request #8094 from magento/ss-reviseinstructions
Update CONTRIBUTING.md
2 parents 7bdd6d8 + a8e289c commit 24199f6

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

.github/CONTRIBUTING.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The following diagram shows the contribution workflow:
4646

4747
In general, you should use `master` as the base branch when creating a PR. If your contribution is related to a release that is in progress, use a version-specific integration branch, such as `develop`.
4848

49-
1. Complete the pull request template.
49+
1. Complete the pull request template. Review the [Pull Request Process page](https://github.com/magento/devdocs/wiki/Pull-Request-Process) to learn how to complete a PR (with info about completing the template, adding a `whatsnew`, and more.)
5050

5151
**We will close your pull request if you do not complete the template.**
5252

@@ -63,7 +63,7 @@ The following guidelines may answer most of your questions and help you get star
6363
- Write content using Markdown. See the [Templates](#templates) section for examples.
6464
- Review existing [pull requests](https://github.com/magento/devdocs/pulls) and [issues](https://github.com/magento/devdocs/issues) to avoid duplicating work.
6565
- For large contributions, or changes that include multiple files, [open an issue](#report-an-issue) and discuss it with us first. This helps prevent duplicate or unnecessary work.
66-
- Do not make global find-and-replace changes without first creating an issue and discussing it with us. Global changes can have unintended consequences.
66+
- Do not make global find-and-replace changes without first [creating an issue](https://github.com/magento/devdocs/issues/new/choose) and discussing it with us. Global changes can have unintended consequences.
6767
- Do not make changes to content in the [`_data/codebase`](https://github.com/magento/devdocs/tree/master/src/_data/codebase) directory, which contains auto-generated data from Magento source code. Any manual changes will be lost when the file regenerates.
6868
- Combine multiple small changes (such as minor editorial and technical changes) into a single pull request. This helps us efficiently and effectively facilitate your contribution.
6969
- Familiarize yourself with the organization and conventions of our existing documentation before creating a pull request. Changes that are consistent with our style and conventions have a higher acceptance rate.
@@ -110,7 +110,6 @@ We provide templates to help you get started writing new content and understandi
110110
The Markdown (.md) file's metadata is a set of YAML key-value pairs. The metadata section is located at the top of each file. For more info, see the [Basic Template](https://devdocs.magento.com/contributor-guide/templates/basic_template.html).
111111

112112
```yaml
113-
114113
---
115114
group:
116115
title:

0 commit comments

Comments
 (0)