s_ranjbar/summer_course_2024
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update 'CONTRIBUTING.md'

Browse Source
This commit is contained in:
Guille 2020-06-09 08:45:17 -04:00
parent faaa2a7c79
commit 73512f493d
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
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:
* prove that your code works correctly. 1. Prove that your code works correctly.
* guard against future breaking changes to lower the maintenance cost. 2. 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:
* Clearly indicate which features are affected by your changes. 1. Clearly indicate which features are affected by your changes.
* Technical reasons for the changes. 2. 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.