Skip to content

Commit da66565

Browse files
committed
Update README badges and add CONTRIBUTING.md
1 parent 8560b8d commit da66565

2 files changed

Lines changed: 75 additions & 10 deletions

File tree

CONTRIBUTING.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributing to FastPing
2+
3+
Thank you for your interest in contributing to the FastPing PowerShell module!
4+
5+
## Prerequisites
6+
7+
- **PowerShell**: Version 5.1 or PowerShell 7.x
8+
- **Git**: For version control
9+
10+
## Local Development
11+
12+
### Initial Setup
13+
14+
1. Clone the repository:
15+
```powershell
16+
git clone https://github.com/austoonz/FastPing.git
17+
cd FastPing
18+
```
19+
20+
2. Install PowerShell dependencies:
21+
```powershell
22+
.\install_nuget.ps1
23+
.\install_modules.ps1
24+
```
25+
26+
### Building the Module
27+
28+
```powershell
29+
# Build the module
30+
.\build.ps1 -Build
31+
32+
# Run tests
33+
.\build.ps1 -Test
34+
35+
# Run code analysis
36+
.\build.ps1 -Analyze
37+
38+
# Auto-format code
39+
.\build.ps1 -Fix
40+
41+
# Full build pipeline (clean, analyze, test, build, package)
42+
.\build.ps1 -Full
43+
```
44+
45+
## Development Workflow
46+
47+
1. Create a feature branch
48+
2. Make your changes
49+
3. Run `.\build.ps1 -Full` to validate
50+
4. Commit and push
51+
5. Create a Pull Request
52+
53+
## Testing Guidelines
54+
55+
- **Minimum Coverage**: 80% code coverage
56+
- **Test Framework**: Pester 5.3.0+
57+
- **Test Location**: `src/Tests/Unit/`
58+
59+
## Code Style
60+
61+
- Follow PowerShell best practices
62+
- Use single quotes for static strings
63+
- Use double quotes for variable expansion
64+
- Always use named parameters for clarity
65+
66+
## Getting Help
67+
68+
- **Issues**: Report bugs via [GitHub Issues](https://github.com/austoonz/FastPing/issues)
69+
- **Documentation**: [Online documentation](https://austoonz.github.io/FastPing/)
70+
71+
## License
72+
73+
By contributing, you agree that your contributions will be licensed under the same license as the project.

README.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# FastPing
22

3+
[![CI](https://github.com/austoonz/FastPing/actions/workflows/ci.yml/badge.svg)](https://github.com/austoonz/FastPing/actions/workflows/ci.yml)
4+
[![Documentation](https://github.com/austoonz/FastPing/actions/workflows/docs.yml/badge.svg)](https://github.com/austoonz/FastPing/actions/workflows/docs.yml)
35
[![Minimum Supported PowerShell Version][powershell-minimum]][powershell-github]
46
[![PowerShell Gallery][psgallery-img]][psgallery-site]
57

@@ -8,16 +10,6 @@
810
[psgallery-img]: https://img.shields.io/powershellgallery/dt/FastPing.svg
911
[psgallery-site]: https://www.powershellgallery.com/packages/FastPing
1012

11-
Branch | Windows | Linux |
12-
--- | --- | --- |
13-
master | ![Build Status][master-windows] | ![Build Status][master-linux] |
14-
development | ![Build Status][development-windows] | ![Build Status][development-linux] |
15-
16-
[master-windows]: https://codebuild.us-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiMkpSVnUrNFQzU1BvWlFTUzJFaUZlRnRwTmtRSzRjYXdncjRHZ1E3WHNYTGJiWURMRGFEQWJYbk42allBUVBCMVRsRHhYcWh1NFR0M24yOXRVNVY1ZVd3PSIsIml2UGFyYW1ldGVyU3BlYyI6InBSK096RWlJL2Vwd2w1SWsiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master
17-
[master-linux]: https://codebuild.us-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiU0pvako5QzMzZkpzUi9Ndk5PWVdEbzZuRjM1TnZlR0JMSWNKTmR4Ky8xeCtwSWNyV3hHRGtqTXRiRTFud1B4UlZ1bnhGZ01PZy9OaXhlL1plVWdQdnpnPSIsIml2UGFyYW1ldGVyU3BlYyI6IlgraytsdU42UjFPTU0wV0YiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master
18-
[development-windows]: https://codebuild.us-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiMkpSVnUrNFQzU1BvWlFTUzJFaUZlRnRwTmtRSzRjYXdncjRHZ1E3WHNYTGJiWURMRGFEQWJYbk42allBUVBCMVRsRHhYcWh1NFR0M24yOXRVNVY1ZVd3PSIsIml2UGFyYW1ldGVyU3BlYyI6InBSK096RWlJL2Vwd2w1SWsiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=development
19-
[development-linux]: https://codebuild.us-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiU0pvako5QzMzZkpzUi9Ndk5PWVdEbzZuRjM1TnZlR0JMSWNKTmR4Ky8xeCtwSWNyV3hHRGtqTXRiRTFud1B4UlZ1bnhGZ01PZy9OaXhlL1plVWdQdnpnPSIsIml2UGFyYW1ldGVyU3BlYyI6IlgraytsdU42UjFPTU0wV0YiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=development
20-
2113

2214
## Synopsis
2315

0 commit comments

Comments
 (0)