|
| 1 | +# Contributing to the SQL Server First Responder Kit |
| 2 | + |
| 3 | +First of all, welcome! We're excited that you'd like to contribute. How would you like to help? |
| 4 | + |
| 5 | +* [I'd like to report a bug or request an enhancement](#how-to-report-bugs-or-request-enhancements) |
| 6 | +* [I'd like to write new T-SQL checks](#how-to-write-new-t-sql-checks) |
| 7 | +* [I'd like to fix bugs in T-SQL checks](#how-to-fix-bugs-in-existing-t-sql-checks) |
| 8 | +* [I'd like to test checks written by someone else](#how-to-test-checks-written-by-someone-else) |
| 9 | +* [I'd like to write or update documentation](#how-to-write-or-update-documentation) |
| 10 | + |
| 11 | +Everyone here is expected to abide by the [Contributor Covenant Code of Conduct](#the-contributor-covenant-code-of-conduct). |
| 12 | + |
| 13 | +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](https://sqlps.io/slack/), and we're in the [#FirstResponderKit channel](https://sqlcommunity.slack.com/messages/firstresponderkit/). We welcome newcomers, and there's always a way you can help. |
| 14 | + |
| 15 | +## How to Report Bugs or Request Enhancements |
| 16 | + |
| 17 | +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, too, because we often decline things that aren't a good fit for these tools. |
| 18 | + |
| 19 | +If you can't find a similar issue, go ahead and open your own. Include as much detail as you can - what you're seeing now, and what you'd like to see. |
| 20 | + |
| 21 | +When requesting new checks, keep in mind that we want to focus on: |
| 22 | + |
| 23 | +* Actionable warnings - SQL Server folks are usually overwhelmed with data, and we only want to report on things they can actually do something about |
| 24 | +* Performance issues or reliability risks - if it's just a setting we don't agree with, let's set that aside |
| 25 | +* Things that end users or managers will notice - if we're going to have someone change a setting on their system, we want it to be worth their time |
| 26 | + |
| 27 | +Now head on over to the [Github issues list] and get started. |
| 28 | + |
| 29 | +## How to Write New T-SQL Checks |
| 30 | + |
| 31 | +Before you code, check the [Github issues list] for what you're trying to do - there may already be an issue for it. Make sure to search through closed issues, too, because we often decline things that aren't a good fit for these tools. |
| 32 | + |
| 33 | +If you've got a new idea that isn't covered in an existing issue, open a Github issue for it. Outline what you'd like to do, and how you'd like to code it. This just helps make sure other users agree that it's a good idea to add to these tools. |
| 34 | + |
| 35 | +After a discussion, to start coding, [open a new Github branch.](https://www.brentozar.com/archive/2015/07/pull-request-101-for-dbas-using-github/) This lets you code in your own area without impacting anyone else. When your code is ready, test it on a case-sensitive instance of the oldest supported version of SQL Server (2008), and the newest version (2016). |
| 36 | + |
| 37 | +When it's ready for review, make a pull request, and one of the core contributors can check your work. |
| 38 | + |
| 39 | +## How to Fix Bugs in Existing T-SQL Checks |
| 40 | + |
| 41 | +(stub) |
| 42 | + |
| 43 | +## How to Test Checks Written by Someone Else |
| 44 | + |
| 45 | +(stub) |
| 46 | + |
| 47 | +* Test only on case-sensitive instances. A surprising number of folks out there run on these. |
| 48 | +* Test on as many currently-supported versions of SQL Server as possible. At minimum, test on the oldest version (currently 2008), and the newest version (currently 2016). |
| 49 | + |
| 50 | +## How to Write or Update Documentation |
| 51 | + |
| 52 | +(stub) |
| 53 | + |
| 54 | +## The Contributor Covenant Code of Conduct |
| 55 | + |
| 56 | +### Our Pledge |
| 57 | + |
| 58 | +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. |
| 59 | + |
| 60 | +### Our Standards |
| 61 | + |
| 62 | +Examples of behavior that contributes to creating a positive environment |
| 63 | +include: |
| 64 | + |
| 65 | +* Using welcoming and inclusive language |
| 66 | +* Being respectful of differing viewpoints and experiences |
| 67 | +* Gracefully accepting constructive criticism |
| 68 | +* Focusing on what is best for the community |
| 69 | +* Showing empathy towards other community members |
| 70 | + |
| 71 | +Examples of unacceptable behavior by participants include: |
| 72 | + |
| 73 | +* The use of sexualized language or imagery and unwelcome sexual attention or |
| 74 | + advances |
| 75 | +* Trolling, insulting/derogatory comments, and personal or political attacks |
| 76 | +* Public or private harassment |
| 77 | +* Publishing others' private information, such as a physical or electronic |
| 78 | + address, without explicit permission |
| 79 | +* Other conduct which could reasonably be considered inappropriate in a |
| 80 | + professional setting |
| 81 | + |
| 82 | +### Our Responsibilities |
| 83 | + |
| 84 | +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. |
| 85 | + |
| 86 | +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. |
| 87 | + |
| 88 | +### Scope |
| 89 | + |
| 90 | +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. |
| 91 | + |
| 92 | +### Enforcement |
| 93 | + |
| 94 | +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. 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. |
| 95 | + |
| 96 | +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. |
| 97 | + |
| 98 | +### Attribution |
| 99 | + |
| 100 | +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, |
| 101 | +available at [http://contributor-covenant.org/version/1/4][version] |
| 102 | + |
| 103 | +[homepage]: http://contributor-covenant.org |
| 104 | +[version]: http://contributor-covenant.org/version/1/4/ |
| 105 | +[Github issues list]:https://github.com/BrentOzarULTD/SQL-Server-First-Responder-Kit/issues |
0 commit comments