Skip to content
This repository has been archived by the owner on Feb 19, 2021. It is now read-only.

Latest commit

 

History

History
64 lines (44 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

64 lines (44 loc) · 3 KB
Raw

Contribute to Stryker

This is the contribution guide for Stryker-mocha-runner. Great to have you here! Here are a few ways you can help make this project better.

Team members

  • Simon de Lang: First developer on Stryker. Started Stryker as part of his thesis at Info Support. simondel on github.
  • Nico Jansen: Second developer on Stryker. Originaly came up with the idea for the mutation testing framework as a thesis at Info Support. nicojs on github or @_nicojs on twitter

Learn & listen

Get in touch with us through twitter or via the Stryker gitter

Adding new features

New features are welcome! Either as requests or proposals.

  1. Please create an issue first or let us know via the Stryker gitter
  2. Create a fork on your github account.
  3. When writing your code, please conform to the existing coding style. See .editorconfig and the typescript guidelines
  4. Please create or edit unit tests or integration tests.
  5. Run the tests using npm test
  6. When creating commits, please conform to the angular commit message style. Namely in the form <type>(<scope>): <subject>\n\n[body]
    • Type: feat, fix, docs, style, refactor, test, chore.
    • Scope can the the file or group of files (not a strict right or wrong)
    • Subject and body: present tense (changedchange, addedadd) and include motivation and contrasts with previous behavior

Don't get discouraged! We estimate that the response time from the maintainers is around a day or so.

Bug triage

Found a bug? Don't worry, we'll fix it, or you can ;)

Please report a bug report on our issues page. In this please:

  1. Label the issue as bug
  2. Explain what the bug is in clear English
  3. Include reproduction steps This can be an example project, code snippit, etc
  4. Include the expected behaviour.
  5. Include actual behaviour.
  6. Add more details if required (i.e. which browser, which test runner, which versions, etc)

Beta testing

Stryker-mocha-runner is still in Beta mode. So we need your input! What do you want to see changed in our api? Or do you think there is a better approach? Please let us know!

Documentation

Todo... sorry ;)

Community

Do you want to help? Great! These are a few things you can do:

  • Evangelize mutation testing
    Mutation testing is still relatively new, especially in JavaScript. Please help us get the word out there!
    Share your stories in blog posts an on social media. Please inform us about it!
  • Did you use Stryker? Your feedback is very valuable to us. Good and bad! Please contact us and let us know what you think