From 455d09f00ebfc2f20881bf301b05c3d5333d3894 Mon Sep 17 00:00:00 2001 From: Guille Date: Tue, 9 Jun 2020 08:17:48 -0400 Subject: [PATCH] Update 'CONTRIBUTING.md' Fix code anchors --- CONTRIBUTING.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 02c87642..382b832b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,10 +6,10 @@ Before sending your pull requests, make sure you followed this list. - Read [contributing guidelines](CONTRIBUTING.md). - Read [Code of Conduct](CODE_OF_CONDUCT.md). -- Check if my changes are consistent with the [guidelines](CONTRIBUTING.md#general-guidelines-and-philosophy-for-contribution). -- Changes are consistent with the [Coding Style](CONTRIBUTING.md#coding-style). -- Manually test your code and add [Unit Tests](CONTRIBUTING.md#testing_best_practices). -- [Document your work](CONTRIBUTING.md#markdown-header-documentation). +- Check if my changes are consistent with the [guidelines](CONTRIBUTING.md#user-content-general-guidelines-and-philosophy-for-contribution). +- Changes are consistent with the [Coding Style](CONTRIBUTING.md#user-content-coding-style). +- Manually test your code and add [Unit Tests](CONTRIBUTING.md#user-content-testing-best-practices). +- [Document your work](CONTRIBUTING.md#user-content-documentation). ## How to become a contributor and submit your own code @@ -61,12 +61,14 @@ At the top of any new file a small header with author contact information and th """ -#### Python coding style +#### Coding style Changes to CERC Libs python code should conform to our coding style [Cerc Python Style Guide](PYGUIDE.md) -Use `pylint` to check your Python changes. To install `pylint` and check a file +But as a general basis all contributions need to be focus in the concept of code clarity and use `pylint` to check your Python changes. + +To install `pylint` and check a file with `pylint` against Cerc custom style definition: ```bash