Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 5.93 KB

CONTRIBUTING.md

File metadata and controls

67 lines (46 loc) · 5.93 KB
Raw

Introduction

First off, thank you for considering contributing to MSBuild.Sdk.SqlProj. It's people like you that make this such a great project. Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

You can contribute anything to this project, from improving documentation and triaging bugs to modifying the code. All of these are valuable contributions and you shouldn't hesitate to do any of those things.

Ground Rules

Make sure you read through our code of conduct first and make sure you understand it before contributing.

In addition, consider the following when contributing:

  • Ensure cross-platform compatibility for every change that's accepted. Windows, Mac, Linux.
  • Create issues for any major changes and enhancements that you wish to make before sending a PR. Discuss things transparently and get community feedback.
  • Keep feature versions as small as possible, preferably one new feature per version.
  • Make sure you update the README.md for any new features you introduce.
  • New features should be added with ample tests to ensure it works correctly.

Your First Contribution

If this is the first time your considering contributing to this project please have a look at the help wanted issues. Don't hesitate to comment on those issues if you need help or guidance on how to get started with those issues. We're here to help you.

If you have never contributed to an open source project at all, have a look at http://makeapullrequest.com/, http://www.firsttimersonly.com/ and How to Contribute to an Open Source Project on GitHub for some help and guidance.

At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first 😸

If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.

Getting started

In order to get started contributing code, make sure you have the following installed on your machine:

This project is made up of a command line tool that does most of the heavy lifting and an accompanying NuGet package that puts it all together. The command line tool is accompanied with a set of unit tests in the test/DacpacTool.Tests folder.

In order to test your changes on your development machine you should first run dotnet build from the src/MSBuild.Sdk.SqlProj folder. This will build the command line tool for the supported target frameworks (netcoreapp2.1, netcoreapp3.1, netcoreapp5.0 as of this writing) and copy those outputs to the src/MSBuild.Sdk.SqlProj/tools/<target-framework> folders. You can then build any of the test projects in the test folder to try out your changes without having to build the SDK package and push it a NuGet package feed. This works because these projects reference the Sdk.props and Sdk.targets files directly like for example TestProjectWithPackageReference.csproj:

<Project>
  <Import Project="$(MSBuildThisFileDirectory)../../src/MSBuild.Sdk.SqlProj/Sdk/Sdk.props" />

    ...

  <Import Project="$(MSBuildThisFileDirectory)../../src/MSBuild.Sdk.SqlProj/Sdk/Sdk.targets" />
</Project>

Note: The TestProjectWithSDKRef.csproj is an exception in that it references the SDK as a NuGet package. In order to test this project locally you will need to run dotnet pack in the src/MSBuild.Sdk.SqlProj folder and push the resulting NuGet package to a NuGet feed or place it in a directory on your system somewhere and add that folder as a NuGet package source.

If you want to debug your local changes, you can pass the MSBuildSdkSqlProjDebug property with a value of True on the command line using dotnet build /p:MSBuildSdkSqlProjDebug=True when you build any of the test projects mentioned above. This will ensure that the command line tool will wait for a debugger to attach before it will do any actual work.

When you're ready to make code changes, follow these steps:

  1. Create your own fork of the code
  2. Do the changes in your fork
  3. If you like the change and think the project could use it:
    • Be sure you have followed the code style for the project.
    • Note the Code of Conduct.
    • Send a pull request.
    • Make sure that the CI pipeline is green.

How to report a bug

If you find a security vulnerability, do NOT open an issue. Email [email protected] instead.

For all other bugs, please report them through the GitHub issue tracker. Make sure you include at least the version of MSBuild.Sdk.SqlProj you're using as well as the platform you encountered the bug on (ie. Windows, Mac, Linux). Describe what you did, what you expected to see and what you see instead.

How to suggest a feature or enhancement

Feel free to provide feature suggestions or enhancements to this project through the GitHub issue tracker as well. Note that this project currently isn't our top priority, so it could very well take a long time before we get time to implement it. If it is important to you, please consider contributing a PR for the feature.

Code review process

Before any change is merged it will be reviewed by someone from the team.