Update 'CONTRIBUTING.md'
Fix code anchors
This commit is contained in:
parent
a91a8733f1
commit
455d09f00e
@ -6,10 +6,10 @@ Before sending your pull requests, make sure you followed this list.
|
|||||||
|
|
||||||
- Read [contributing guidelines](CONTRIBUTING.md).
|
- Read [contributing guidelines](CONTRIBUTING.md).
|
||||||
- Read [Code of Conduct](CODE_OF_CONDUCT.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).
|
- 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#coding-style).
|
- Changes are consistent with the [Coding Style](CONTRIBUTING.md#user-content-coding-style).
|
||||||
- Manually test your code and add [Unit Tests](CONTRIBUTING.md#testing_best_practices).
|
- Manually test your code and add [Unit Tests](CONTRIBUTING.md#user-content-testing-best-practices).
|
||||||
- [Document your work](CONTRIBUTING.md#markdown-header-documentation).
|
- [Document your work](CONTRIBUTING.md#user-content-documentation).
|
||||||
|
|
||||||
## How to become a contributor and submit your own code
|
## 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
|
Changes to CERC Libs python code should conform to our coding style
|
||||||
[Cerc Python Style Guide](PYGUIDE.md)
|
[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:
|
with `pylint` against Cerc custom style definition:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
Loading…
Reference in New Issue
Block a user