Skip to content

Latest commit

 

History

History
107 lines (76 loc) · 3.49 KB

CONTRIBUTING.md

File metadata and controls

107 lines (76 loc) · 3.49 KB

Contributing to RT-MASK

First off, thank you for considering contributing to RT-MASK! It's people like you that make RT-MASK such a great tool.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct:

  1. Be respectful of differing viewpoints and experiences
  2. Accept constructive criticism gracefully
  3. Focus on what is best for the community
  4. Show empathy towards other community members

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the issue list 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 environment details:
    • OS version
    • PowerShell/Bash version
    • Tool version
    • Relevant dependencies versions

Suggesting Enhancements

If you have a suggestion for the project, we'd love to hear it. Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

  • A clear and descriptive title
  • A detailed description of the proposed feature
  • Any possible drawbacks or challenges you foresee
  • If possible, a rough implementation approach

Pull Requests

  1. Fork the repo and create your branch from main
  2. If you've added code that should be tested, add tests
  3. If you've changed APIs, update the documentation
  4. Ensure the test suite passes
  5. Make sure your code follows the existing style
  6. Issue that pull request!

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
  • Include comment-based help for functions
  • Follow PowerShell Best Practices

Bash Styleguide

  • Use lowercase for function names
  • Use lowercase for variable names
  • Use underscores to separate words in names
  • Quote all variable expansions
  • Follow Google's Shell Style Guide

Documentation

  • Use Markdown for documentation
  • Keep language simple and clear
  • Include examples for new features
  • Update README.md with any new dependencies or features
  • Add comments to explain complex code sections

Testing

  • Write tests for new features
  • Update tests when modifying features
  • Ensure all tests pass before submitting PR
  • Include both positive and negative test cases

Additional Notes

Issue and Pull Request Labels

  • bug: Something isn't working
  • enhancement: New feature or request
  • documentation: Improvements or additions to documentation
  • good first issue: Good for newcomers
  • help wanted: Extra attention is needed

Recognition

Contributors who help improve RT-MASK will be recognized in the following ways:

  1. Added to the Contributors section in README.md
  2. Mentioned in release notes when their feature is included
  3. Given credit in code comments for significant contributions

Thank you for contributing to RT-MASK!