Skip to content

Latest commit

 

History

History
23 lines (17 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

23 lines (17 loc) · 1.42 KB
Raw

Contributing to the Domain_Audit tool

I would love your input. Feel free to contribute and send a pull request adding a new PowerShell function.

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same GPL-3.0 Licents that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

This is an example of a bug report I wrote, and I think it's not a bad model. Here's another example from Craig Hockenberry.

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can. My stackoverflow question includes sample code that anyone with a base R setup can run to reproduce what I was seeing
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.