Work on README.md
This commit is contained in:
parent
215360ceef
commit
d7a5547128
4 changed files with 24 additions and 22 deletions
15
CONTRIBUTING.md
Normal file
15
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
Thank you for showing your interest in contributing! Contributions are the most welcome. Anything including small fixes is greatly appreciated.
|
||||
|
||||
Please keep your new code consistent with the existing codebase and follow the industry's best practices. Before committing, please make sure that your code passes the linting & security scanning suite.
|
||||
|
||||
To install linting tools, execute the following commands:
|
||||
```sh
|
||||
make lint-deps
|
||||
make security-check-deps
|
||||
```
|
||||
|
||||
After that, you will be able to run the linter and the security scanning tool.
|
||||
```sh
|
||||
make lint
|
||||
make security-check
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue