Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 1.4 KB

How to contribute

Submitting changes

Pull requests are welcomed :)

For significant effort or feature work, it is preferred to start by filing an issue to discuss your approach before you start coding.

Hacking / debugging

  • Simply open the userscript in Tampermonkey's dashboard and hack away
  • Hit Ctrl+S to save
  • Refresh the target page to test your changes

Once you're done, copy your script from the dashboard into the actual source file of a clone of this repo. Then propose a pull request.

Testing before a PR

For each PR, make sure:

  • Version is incremented following semantic versioning
  • Runs in latest stable Chrome and Firefox without Javascript errors
  • Works in both dev.azure.com/account and account.visualstudio.com
  • Customizations work in both light and dark theme
  • Does not report any issues in eslint (run npm run build)

Testing pull request changes

To test the changes in a pull request:

  • Disable any versions of the userscript you have enabled (via Tampermonkey)
  • Install the userscript from the GitHub PR
    • Go to the Files Changed tab
    • Hit the ... button on the top-right of the file
    • Hit View file
    • Hit Raw button in the page that comes up
  • Test
  • Delete the userscript from the PR
  • Re-enable any original userscript

Coding conventions

  • Blocks of code are commented
  • Follow the conventions as specified in eslint config (roughly, Airbnb JS style)