From faaa2a7c798c462b7bd97cf5faebd53b11d23baa Mon Sep 17 00:00:00 2001 From: Guille Date: Tue, 9 Jun 2020 08:43:49 -0400 Subject: [PATCH] Update 'CONTRIBUTING.md' --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5bb9632f..6198e3a9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,13 +34,13 @@ Before sending your pull request for review, make sure your changes are consiste #### General guidelines and philosophy for contribution * Include unit tests when you contribute new features, as they help to: -..1. prove that your code works correctly. -..2. guard against future breaking changes to lower the maintenance cost. + * prove that your code works correctly. + * guard against future breaking changes to lower the maintenance cost. * Bug fixes also generally require unit tests, because the presence of bugs usually indicates insufficient test coverage. * Keep backward compatibility in mind when you change code in CERC Libs, and if you need to broke the backward compatibility, please ensure that you: -. -..1. Clearly indicate which features are affected by your changes. -..2. Technical reasons for the changes. + + * Clearly indicate which features are affected by your changes. + * Technical reasons for the changes. * Tests should follow the [testing best practices](CONTRIBUTING.md#user-content-testing-best-practices) guide.