First of all, welcome! We're excited that you'd like to contribute. How would you like to help?
Everyone here is expected to abide by the Contributor Covenant Code of Conduct.
Wanna do something else, or have a question not answered here? Hop into Slack and ask us questions before you get started. Get an invite to SQLCommunity.slack.com, and we're in the #FirstResponderKit channel. We welcome newcomers, and there's always a way you can help.
Check out the Github issues list. Search for what you're interested in - there may already be an issue for it. Make sure to search through closed issues list, too, because we may have already fixed the bug in the development branch. To try the most recent version of the code that we haven't released to the public yet, download the dev branch version.
If you can't find a similar issue, go ahead and open your own. Include as much detail as you can - error messages, screenshots, what you're seeing now, and what you'd expect to see instead.
Open source is community-built software. Anyone is welcome to build things that would help make their job easier, and you're welcome to use AI to help build the features you want.
The first step is to open a new issue describing the feature you want, and we'll have a discussion with you to make sure it's a good fit for the First Responder Kit. We'll also make notes about what things to consider while you're coding it (or while you're telling AI to code it for you, ha ha ho ho.)
Don't touch the files that start with Install, like Install-All-Scripts.sql. Those are dynamically generated. You only have to touch the ones that start with sp_.
Your code needs to compile & run on all currently supported versions of SQL Server. It's okay if functionality degrades, like if not all features are available, but at minimum the code has to compile and run.
Your code must handle:
- Case sensitive databases & servers
- Unicode object names (databases, tables, indexes, etc.)
- Different date formats - for guidance: https://xkcd.com/1179/
We know that's a pain, but that's the kind of thing we find out in the wild. Of course you would never build a server like that, but...
If it's your first time contributing code via Github, check out Rob Sewell's post on how to fork a GitHub repository and contribute to an open source project.
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
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
- 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
- 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 Help@BrentOzar.com. 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