Skip to content

Contributing

Jump to bottom
Darren Gosbell edited this page Feb 2, 2021 · 1 revision
Clone this wiki locally

Contributing to DAX Studio

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Pointing out areas where the documentation needs improving

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use a version of Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Make sure you've let us know what you are planning to work on either by raising or commenting on an issue.
  2. Fork the repo and create your branch from develop.
  3. If you've added code that should be tested, add tests to the DaxStudio.Tests project.
  4. If you've changed the UI or added new functionality, update the documentation.
  5. Ensure the test suite passes.
  6. Issue that pull request!

Any contributions you make will be under the MS-PL Software License

In short, when you submit code changes, your submissions are understood to be under the same [MS-PL License]https://opensource.org/licenses/ms-pl.html) 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 steps to reproduce the issue

Great Bug Reports tend to have:

  • A quick summary and/or background
  • include version information both for DAX Studio and your Data Source (eg. Power BI Desktop, SSAS, AzureAS, etc). Also make sure you are running the latest version of DAX Studio.
  • Steps to reproduce
    • Be specific!
    • Include an example data model (such as a .bom or .pbix file zipped up) if you can and if it's applicable to your issue
  • 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. With a good bug report we can often start working on a fix immediately. But if we have to go back and forth asking questions and waiting for clarifications, with timezone differences and time pressures from our day jobs it can sometimes take a week or more to get a complete understanding of an issue before we can event start investigating it.

License

By contributing, you agree that your contributions will be licensed under the MS-PL License.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft