This is the contribution guide for Stryker. Great to have you here! Here are a few ways you can help make this project better.
Get in touch with us through twitter or via the Stryker gitter
New features are welcome! Either as requests or proposals.
- Please create an issue first or let us know via the Stryker gitter
- Create a fork on your github account.
- When writing your code, please conform to the existing coding style. See .editorconfig and the typescript guidelines
- Please create or edit unit tests or integration tests.
- Run the tests using
npm test - 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 be 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 behaviour
Don't get discouraged! We estimate that the response time from the maintainers is around a day or so.
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:
- Label the issue as bug
- Explain what the bug is in clear English
- Include reproduction steps This can be an example project, code snippet, etc
- Include the expected behaviour.
- Include actual behaviour.
- Add more details if required (i.e. which browser, which test runner, which versions, etc)
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