s_ranjbar/city_retrofit
1
0
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update 'CONTRIBUTING.md'

Browse Source
This commit is contained in:
Guille 2020-06-09 08:43:49 -04:00
parent bfd8c10bff
commit faaa2a7c79
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -34,13 +34,13 @@ Before sending your pull request for review, make sure your changes are consiste
#### General guidelines and philosophy for contribution #### General guidelines and philosophy for contribution
* Include unit tests when you contribute new features, as they help to: * Include unit tests when you contribute new features, as they help to:
..1. prove that your code works correctly. * prove that your code works correctly.
..2. guard against future breaking changes to lower the maintenance cost. * 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. * 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: * 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. * Clearly indicate which features are affected by your changes.
..2. Technical reasons for the changes. * Technical reasons for the changes.
* Tests should follow the * Tests should follow the
[testing best practices](CONTRIBUTING.md#user-content-testing-best-practices) [testing best practices](CONTRIBUTING.md#user-content-testing-best-practices)
guide. guide.