Thank you for your interest in 365Inspect! Our aim is to help increase awareness of issues, misconfigurations, and best practices in the M365 ecosystem, all the while helping to improve the security of M365 tenants for our customers and the community as a whole. As the tool continues to evolve, we hope to hear your ideas, see your submissions, and hear your thoughts and experiences with 365Inspect! Thank you for being such an awesome community!
When contributing to this repository, please first determine and use the correct template for your issue, feature request, or visit our Discussions page for any other sharing of ideas, questions, or just to interact with other members of the community!
Please note we have a code of conduct, please follow it in all your interactions with the project.
We use github to host code, track issues, feature requests, and accept pull requests.
Any submitted code changes or additions are subject to the MIT License that covers the project. Feel free to contact the maintainers if that's a concern.
Report bugs using Github's issues
Report a bug by opening a new issue; and selecting the 'Bug report' template. Open a feature request by opening a new issue; and selecting the 'Feature request' template.
It is important that any submitted bug reports are clear and can be reproduced. To ensure that your bug report gets the attention it deserves, please make sure to include the following data:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can
- Expected outcome
- Actual outcome
- Anything else you think may be of value. Examples include:
- Screenshots (ensure no sensitive information is being captured)
- Operating System information
- PowerShell version information
- Powershell module version information
It is important that any submitted feature requests are clear and easy to understand so we can make your idea a reality. Please make sure to include the following data:
- A quick summary and/or background
- What is the problem your idea will solve?
- Be specific
- Give sample code or pseudo code if you can
- Expected outcome
- Be specific
- How would this benefit you and the community?
- What should the result look like?
- Be specific
365Inspect is written using VS Code. This keeps spacing conventions and alias use (or lack thereof) consistent across all of the included scripts. Developing new inspectors and features within VS Code is encouraged, but not required. In the war of "Tabs vs Spaces", we fall squarely into the "spaces" camp and request that spacing and tabbing be set to four spaces for consistency. Spaces are consistently a single column regardless of environment, where tab columns can vary.
- Fork the repo and create your branch from
main. - Add your new code, changes, or bug fixes.
- Submit your pull request.
In the interest of fostering an open and welcoming community, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone.
Examples of behavior that contributes to creating a positive environment include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery and unwelcome sexual attention or advances.
- The use of previously common terminology - "whitelist", "blacklist", "master", "slave". We ask that these be replaced with Allow/Block list, and Primary/Secondary or Parent/Child except in certain instances when it is necessary to retain such verbiage (eg, direct quotes, when contained in an article title or link, etc...)
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission (doxing)
- Other conduct which could reasonably be considered inappropriate in a professional setting
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at 365Inspect-public@soteria.io. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4 as well as CONTRIBUTING.md templates available in the following Git and Gist repositories PurpleBooth and briandk