From 340eb54050db1476cbfbb3ec0cc8d20ac540a112 Mon Sep 17 00:00:00 2001 From: rrafols Date: Sat, 6 Oct 2018 00:15:43 +0200 Subject: [PATCH] doc: adding minor clarification to CONTRIBUTING.MD (#79) Thanks for contributing! --- CONTRIBUTING.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0e5f45fe7..fdf02ebcf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,14 +5,13 @@ Should you run into issues with the project, please don't hesitate to let us know by [filing an issue](https://github.com/axa-group/nlp.js/issues/new). -Pull requests containing only failing tests demonstrating the issue are welcomed -and this also helps ensure that your issue won't regress in the future once it's fixed. +Pull requests containing only failing tests demonstrating an issue are also welcomed. Having these tests will help avoiding future regressions of this specific issue once it's fixed. ## Pull Requests We accept [pull requests](https://github.com/axa-group/nlp.js/pull/new/master)! -Generally we like to see pull requests that +Generally we like to see pull requests that: - Maintain the existing code style - Are focused on a single change (i.e. avoid large refactoring or style adjustments in untouched code if not the primary goal of the pull request) @@ -32,4 +31,4 @@ From the root directory, run the tests. ```shell npm test -``` \ No newline at end of file +```