Skip to content

Latest commit

 

History

History
executable file
·
77 lines (53 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
77 lines (53 loc) · 2.59 KB

Contributing to WSL Memory Monitor

First off, thank you for considering contributing to WSL Memory Monitor!

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check existing issues as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include screenshots if possible
  • Include your system details (Windows version, WSL version, RAM, etc.)

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

  • Use a clear and descriptive title
  • Provide a step-by-step description of the suggested enhancement
  • Provide specific examples to demonstrate the steps
  • Describe the current behavior and explain which behavior you expected to see instead
  • Explain why this enhancement would be useful

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Follow the PowerShell style guide
  • Include thoughtfully-worded, well-structured tests
  • Document new code
  • End all files with a newline

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

PowerShell Styleguide

  • Use PascalCase for function names
  • Use camelCase for variable names
  • Always use explicit parameter names
  • Include comment-based help for all functions
  • Use proper indentation (4 spaces)

Documentation Styleguide

  • Use Markdown
  • Reference functions and variables in backticks: Get-WSLProfile
  • Use clear examples with expected output

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

  • bug - Confirmed bugs or reports that are very likely to be bugs
  • enhancement - Feature requests
  • documentation - Improvements or additions to documentation
  • good first issue - Good for newcomers
  • help wanted - Extra attention is needed

Thank you for contributing!