Skip to content

Commit cad6f47

Browse files
bergmeisterJamesWTruher
authored andcommitted
Shorten contribution section in ReadMe and make it more friendly (#911)
* shorten contribution guide and make it more friendly * tewak * fix table of contents
1 parent 30eb91a commit cad6f47

File tree

1 file changed

+9
-20
lines changed

1 file changed

+9
-20
lines changed

README.md

+9-20
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Table of Contents
2828
- [ScriptAnalyzer as a .NET library](#scriptanalyzer-as-a-net-library)
2929
- [Violation Correction](#violation-correction)
3030
- [Project Management Dashboard](#project-management-dashboard)
31-
- [Contributing to ScriptAnalyzer](#contributing-to-scriptanalyzer)
31+
- [Contributions are welcome](#contributions-are-welcome)
3232
- [Creating a Release](#creating-a-release)
3333
- [Code of Conduct](#code-of-conduct)
3434

@@ -349,26 +349,15 @@ Throughput Graph
349349

350350
[Back to ToC](#table-of-contents)
351351

352-
Contributing to ScriptAnalyzer
352+
Contributions are welcome
353353
==============================
354-
You are welcome to contribute to this project. There are many ways to contribute:
355-
356-
1. Submit a bug report via [Issues]( https://github.com/PowerShell/PSScriptAnalyzer/issues). For a guide to submitting good bug reports, please read [Painless Bug Tracking](https://www.joelonsoftware.com/articles/fog0000000029.html).
357-
2. Verify fixes for bugs.
358-
3. Submit your fixes for a bug. Before submitting, please make sure you have:
359-
* Performed code reviews of your own
360-
* Updated the test cases if needed
361-
* Run the test cases to ensure no feature breaks or test breaks
362-
* Added the test cases for new code
363-
4. Submit a feature request.
364-
5. Help answer questions in the discussions list.
365-
6. Submit test cases.
366-
7. Tell others about the project.
367-
8. Tell the developers how much you appreciate the product!
368-
369-
You might also read these two blog posts about contributing code: [Open Source Contribution Etiquette](http://tirania.org/blog/archive/2010/Dec-31.html) by Miguel de Icaza, and [Don’t “Push” Your Pull Requests](https://www.igvita.com/2011/12/19/dont-push-your-pull-requests/) by Ilya Grigorik.
370-
371-
Before submitting a feature or substantial code contribution, please discuss it with the Windows PowerShell team via [Issues](https://github.com/PowerShell/PSScriptAnalyzer/issues), and ensure it follows the product roadmap. Note that all code submissions will be rigorously reviewed by the Windows PowerShell Team. Only those that meet a high bar for both quality and roadmap fit will be merged into the source.
354+
355+
There are many ways to contribute:
356+
357+
1. Open a new bug report, feature request or just ask a question by opening a new issue [here]( https://github.com/PowerShell/PSScriptAnalyzer/issues/new).
358+
2. Participate in the discussions of [issues](https://github.com/PowerShell/PSScriptAnalyzer/issues), [pull requests](https://github.com/PowerShell/PSScriptAnalyzer/pulls) and verify/test fixes or new features.
359+
3. Submit your own fixes or features as a pull request but please discuss it beforehand in an issue if the change is substantial.
360+
4. Submit test cases.
372361

373362
[Back to ToC](#table-of-contents)
374363

0 commit comments

Comments
 (0)