Skip to content

Commit 5ab4152

Browse files
doc: Update contributing guidelines to emphasize issues (#1231)
* Update CONTRIBUTING.md * Apply suggestions from code review Co-authored-by: Kendall Totten <[email protected]> * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md Co-authored-by: Kendall Totten <[email protected]>
1 parent 5e14a7f commit 5ab4152

File tree

1 file changed

+18
-19
lines changed

1 file changed

+18
-19
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,12 @@
55
[cc]: https://www.conventionalcommits.org/en/v1.0.0/#summary
66
[doc]: https://patternfly.github.io/patternfly-elements/getting-started/
77

8-
98
Welcome Flyers! We're so excited that you're considering contributing to PatternFly Elements, the web component implementation of the PatternFly design system.
109

1110
Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE.md).
1211

1312
Please note that this project is released with a [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
1413

15-
## Submitting a pull request
16-
17-
1. [Fork][fork] and clone the repository (see the Quick start in the [README][README.md])
18-
2. Create a new branch. Please use the [conventional commit](cc) formatting for the branch name.
19-
> `git checkout -b feat-my-branch-name`
20-
3. Make your change, [add tests](https://patternfly.github.io/patternfly-elements/develop/step-3/), and make sure the automated testing passes.
21-
4. Push to your fork and [submit a pull request][pr]. Be sure to select from the available PR templates.
22-
23-
24-
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
25-
26-
- Review the documentation.
27-
- Follow the style/format of the existing code.
28-
- Write tests for your changes.
29-
- Keep your change as focused as possible; if there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
30-
- Be responsive during code review, as much as possible.
31-
3214
## Submitting an Issue
3315

3416
### Bug Reporting
@@ -50,9 +32,26 @@ If you have a feature that you think would be a great addition to the project:
5032

5133
To suggest a feature use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md).
5234

35+
## Submitting a pull request
36+
37+
1. Check the [issue queue](https://github.com/patternfly/patternfly-elements/issues). If your pull request does not map to an issue in the queue, please open a [new issue](https://github.com/patternfly/patternfly-elements/issues).
38+
2. [Fork][fork] and clone the repository (see the Quick start in the [README][README.md])
39+
3. Create a new branch. Please use the [conventional commit](cc) formatting for the branch name.
40+
git checkout -b feat-my-branch-name
41+
4. Make your change, [add tests](https://patternfly.github.io/patternfly-elements/develop/step-3/), and make sure the automated testing passes.
42+
5. Push to your fork and [submit a pull request][pr]. Be sure to select from the available PR templates.
43+
44+
45+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
46+
47+
- Review the documentation.
48+
- Follow the style/format of the existing code.
49+
- Write tests for your changes.
50+
- Keep your change as small and focused as possible; if there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
51+
- Be responsive during code review, as much as possible.
5352

5453
## Resources
5554

5655
- [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)
5756
- [Using Pull Requests](https://help.github.com/articles/using-pull-requests/)
58-
- [GitHub Help](https://help.github.com)
57+
- [GitHub Help](https://help.github.com)

0 commit comments

Comments
 (0)